Class OutlineElement
Class OutlineElement
Namespace: Aspose.Note
Assembly: Aspose.Note.dll (25.12.0)
Represents a OutlineElement.
public sealed class OutlineElement : IndentatedNode<IOutlineElementChildNode>, ICompositeNode<IOutlineElementChildNode>, ICompositeNode, IEnumerable<IOutlineElementChildNode>, IEnumerable, IIndentatedNode, IOutlineChildNode, IOutlineElementChildNode, INodeInheritance
object ← Node ← CompositeNodeBase ← CompositeNode<IOutlineElementChildNode> ← IndentatedNode<IOutlineElementChildNode> ← OutlineElement
Implements
ICompositeNode<IOutlineElementChildNode> , ICompositeNode , IEnumerable<IOutlineElementChildNode> , IEnumerable , IIndentatedNode , IOutlineChildNode , IOutlineElementChildNode , INode
Inherited Members
IndentatedNode<IOutlineElementChildNode>.IndentPosition , CompositeNode<IOutlineElementChildNode>.GetEnumerator() , CompositeNode<IOutlineElementChildNode>.InsertChild<T1>(int, T1) , CompositeNode<IOutlineElementChildNode>.InsertChildrenRange(int, IEnumerable<IOutlineElementChildNode>) , CompositeNode<IOutlineElementChildNode>.InsertChildrenRange(int, params IOutlineElementChildNode[]) , CompositeNode<IOutlineElementChildNode>.AppendChildFirst<T1>(T1) , CompositeNode<IOutlineElementChildNode>.AppendChildLast<T1>(T1) , CompositeNode<IOutlineElementChildNode>.RemoveChild<T1>(T1) , CompositeNode<IOutlineElementChildNode>.Accept(DocumentVisitor) , CompositeNode<IOutlineElementChildNode>.GetChildNodes(NodeType) , CompositeNode<IOutlineElementChildNode>.GetChildNodes<T1>() , CompositeNode<IOutlineElementChildNode>.IsComposite , CompositeNode<IOutlineElementChildNode>.FirstChild , CompositeNode<IOutlineElementChildNode>.LastChild , CompositeNodeBase.GetChildNodes(NodeType) , CompositeNodeBase.GetChildNodes<T1>() , Node.Accept(DocumentVisitor) , Node.Document , Node.IsComposite , Node.NodeType , Node.ParentNode , Node.PreviousSibling , Node.NextSibling , object.GetType() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Examples
Shows how to add new image with tag.
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_Tags();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Page page = new Page();
// Initialize Outline class object
Outline outline = new Outline();
// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement();
// Load an image
Image image = new Image(dataDir + "icon.jpg");
// Insert image in the document node
outlineElem.AppendChildLast(image);
image.Tags.Add(NoteTag.CreateYellowStar());
// Add outline element node
outline.AppendChildLast(outlineElem);
// Add outline node
page.AppendChildLast(outline);
// Add page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "AddImageNodeWithTag_out.one";
doc.Save(dataDir);Shows how to retrieve information about list’s formatting.
string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
// Retrieve a collection nodes of the outline element
IList<OutlineElement> nodes = oneFile.GetChildNodes<OutlineElement>();
// Iterate through each node
foreach (OutlineElement node in nodes)
{
if (node.NumberList != null)
{
NumberList list = node.NumberList;
// Retrieve font name
Console.WriteLine("Font Name: " + list.Font);
// Retrieve font length
Console.WriteLine("Font Length: " + list.Font.Length);
// Retrieve font size
Console.WriteLine("Font Size: " + list.FontSize);
// Retrieve font color
Console.WriteLine("Font Color: " + list.FontColor);
// Retrieve format
Console.WriteLine("Font format: " + list.Format);
// Check bold
Console.WriteLine("Is bold: " + list.IsBold);
// Check italic
Console.WriteLine("Is italic: " + list.IsItalic);
Console.WriteLine();
}
}Shows how to insert new list with chinese numbering.
string dataDir = RunExamples.GetDataDir_Text();
// Initialize OneNote document
Document doc = new Document();
// Initialize OneNote page
Page page = new Page();
Outline outline = new Outline();
// Apply text style settings
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text1 = new RichText() { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
//------------------------
OutlineElement outlineElem2 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text2 = new RichText() { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
//------------------------
OutlineElement outlineElem3 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text3 = new RichText() { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
//------------------------
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
page.AppendChildLast(outline);
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "InsertChineseNumberList_out.one";
doc.Save(dataDir);Shows how to insert new bulleted lis.
string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Page page = new Page();
// Initialize Outline class object
Outline outline = new Outline();
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply bullets
OutlineElement outlineElem1 = new OutlineElement() { NumberList = new NumberList("*", "Arial", 10) };
// Initialize RichText class object and apply text style
RichText text1 = new RichText() { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement() { NumberList = new NumberList("*", "Arial", 10) };
RichText text2 = new RichText( ) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement() { NumberList = new NumberList("*", "Arial", 10) };
RichText text3 = new RichText() { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyBulletsOnText_out.one";
doc.Save(dataDir);Shows how to insert new list with numbering.
string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Page page = new Page();
// Initialize Outline class object
Outline outline = new Outline();
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply numbering
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text1 = new RichText() { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text2 = new RichText() { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text3 = new RichText() { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyNumberingOnText_out.one";
doc.Save(dataDir);Constructors
OutlineElement()
public OutlineElement()Properties
AuthorMostRecent
Gets the most recent author of an outline element.
public string AuthorMostRecent { get; }Property Value
AuthorOriginal
Gets the original author of an outline element.
public string AuthorOriginal { get; }Property Value
CreationTime
Gets or sets the creation time.
public DateTime CreationTime { get; set; }Property Value
LastModifiedTime
Gets or sets the last modified time.
public DateTime LastModifiedTime { get; set; }Property Value
NumberList
Gets or sets the style for the numbered list header.
public NumberList NumberList { get; set; }Property Value
Examples
Shows how to retrieve information about list’s formatting.
string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
// Retrieve a collection nodes of the outline element
IList<OutlineElement> nodes = oneFile.GetChildNodes<OutlineElement>();
// Iterate through each node
foreach (OutlineElement node in nodes)
{
if (node.NumberList != null)
{
NumberList list = node.NumberList;
// Retrieve font name
Console.WriteLine("Font Name: " + list.Font);
// Retrieve font length
Console.WriteLine("Font Length: " + list.Font.Length);
// Retrieve font size
Console.WriteLine("Font Size: " + list.FontSize);
// Retrieve font color
Console.WriteLine("Font Color: " + list.FontColor);
// Retrieve format
Console.WriteLine("Font format: " + list.Format);
// Check bold
Console.WriteLine("Is bold: " + list.IsBold);
// Check italic
Console.WriteLine("Is italic: " + list.IsItalic);
Console.WriteLine();
}
}Shows how to insert new list with chinese numbering.
string dataDir = RunExamples.GetDataDir_Text();
// Initialize OneNote document
Document doc = new Document();
// Initialize OneNote page
Page page = new Page();
Outline outline = new Outline();
// Apply text style settings
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text1 = new RichText() { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
//------------------------
OutlineElement outlineElem2 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text2 = new RichText() { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
//------------------------
OutlineElement outlineElem3 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text3 = new RichText() { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
//------------------------
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
page.AppendChildLast(outline);
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "InsertChineseNumberList_out.one";
doc.Save(dataDir);Shows how to insert new bulleted lis.
string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Page page = new Page();
// Initialize Outline class object
Outline outline = new Outline();
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply bullets
OutlineElement outlineElem1 = new OutlineElement() { NumberList = new NumberList("*", "Arial", 10) };
// Initialize RichText class object and apply text style
RichText text1 = new RichText() { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement() { NumberList = new NumberList("*", "Arial", 10) };
RichText text2 = new RichText( ) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement() { NumberList = new NumberList("*", "Arial", 10) };
RichText text3 = new RichText() { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyBulletsOnText_out.one";
doc.Save(dataDir);Shows how to insert new list with numbering.
string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Page page = new Page();
// Initialize Outline class object
Outline outline = new Outline();
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply numbering
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text1 = new RichText() { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text2 = new RichText() { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement() { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text3 = new RichText() { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyNumberingOnText_out.one";
doc.Save(dataDir);Methods
Accept(DocumentVisitor)
Accepts the visitor of the node.
public override void Accept(DocumentVisitor visitor)Parameters
visitor DocumentVisitor
The object of a class derived from the Aspose.Note.DocumentVisitor.
