Class Outline

Class Outline

Namespace: Aspose.Note
Assembly: Aspose.Note.dll (24.12.0)

Represents a Outline.

public sealed class Outline : IndentatedNode<ioutlinechildnode>, ICompositeNode<ioutlinechildnode>, ICompositeNode, IEnumerable<ioutlinechildnode>, IEnumerable, IIndentatedNode, IPageChildNode, INode

Inheritance

objectNodeCompositeNodeBaseCompositeNode<ioutlinechildnode>IndentatedNode<ioutlinechildnode>Outline

Implements

ICompositeNode<ioutlinechildnode>, ICompositeNode, IEnumerable<ioutlinechildnode>, IEnumerable, IIndentatedNode, IPageChildNode, INode

Inherited Members

IndentatedNode<ioutlinechildnode>.IndentPosition, CompositeNode<ioutlinechildnode>.GetEnumerator(), CompositeNode<ioutlinechildnode>.InsertChild<t1>(int, T1), CompositeNode<ioutlinechildnode>.InsertChildrenRange(int, IEnumerable<ioutlinechildnode>), CompositeNode<ioutlinechildnode>.InsertChildrenRange(int, params IOutlineChildNode[]), CompositeNode<ioutlinechildnode>.AppendChildFirst<t1>(T1), CompositeNode<ioutlinechildnode>.AppendChildLast<t1>(T1), CompositeNode<ioutlinechildnode>.RemoveChild<t1>(T1), CompositeNode<ioutlinechildnode>.Accept(DocumentVisitor), CompositeNode<ioutlinechildnode>.GetChildNodes(NodeType), CompositeNode<ioutlinechildnode>.GetChildNodes<t1>(), CompositeNode<ioutlinechildnode>.IsComposite, CompositeNode<ioutlinechildnode>.FirstChild, CompositeNode<ioutlinechildnode>.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.```csharp // 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
                                           Aspose.Note.Page page = new Aspose.Note.Page(doc);

                                           // Initialize Outline class object
                                           Outline outline = new Outline(doc);

                                           // Initialize OutlineElement class object
                                           OutlineElement outlineElem = new OutlineElement(doc);

                                           // Load an image
                                           Aspose.Note.Image image = new Aspose.Note.Image(doc, 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 insert new list with chinese numbering.```csharp
string dataDir = RunExamples.GetDataDir_Text();

                                                               // Initialize OneNote document
                                                               Aspose.Note.Document doc = new Aspose.Note.Document();

                                                               // Initialize OneNote page
                                                               Aspose.Note.Page page = new Aspose.Note.Page(doc);
                                                               Outline outline = new Outline(doc);

                                                               // 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(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
                                                               RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
                                                               outlineElem1.AppendChildLast(text1);

                                                               //------------------------
                                                               OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
                                                               RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
                                                               outlineElem2.AppendChildLast(text2);

                                                               //------------------------
                                                               OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
                                                               RichText text3 = new RichText(doc) { 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.```csharp string dataDir = RunExamples.GetDataDir_Text();

                                            // Create an object of the Document class
                                            Aspose.Note.Document doc = new Aspose.Note.Document();

                                            // Initialize Page class object
                                            Aspose.Note.Page page = new Aspose.Note.Page(doc);

                                            // Initialize Outline class object
                                            Outline outline = new Outline(doc);

                                            // 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(doc) { NumberList = new NumberList("*", "Arial", 10) };

                                            // Initialize RichText class object and apply text style
                                            RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
                                            outlineElem1.AppendChildLast(text1);

                                            OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
                                            RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
                                            outlineElem2.AppendChildLast(text2);

                                            OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("*", "Arial", 10) };
                                            RichText text3 = new RichText(doc) { 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.```csharp
string dataDir = RunExamples.GetDataDir_Text();

                                                       // Create an object of the Document class
                                                       Document doc = new Document();

                                                       // Initialize Page class object
                                                       Aspose.Note.Page page = new Aspose.Note.Page(doc);

                                                       // Initialize Outline class object
                                                       Outline outline = new Outline(doc);

                                                       // 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(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
                                                       RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
                                                       outlineElem1.AppendChildLast(text1);

                                                       OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
                                                       RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
                                                       outlineElem2.AppendChildLast(text2);

                                                       OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
                                                       RichText text3 = new RichText(doc) { 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

Outline()

public Outline()

Properties

DescendantsCannotBeMoved

Gets whether descendants of the outline can be moved.

public bool DescendantsCannotBeMoved { get; set; }

Property Value

bool

HorizontalOffset

Gets or sets the horizontal offset.

public float HorizontalOffset { get; set; }

Property Value

float

LastModifiedTime

Gets or sets the last modified time.

public DateTime LastModifiedTime { get; set; }

Property Value

DateTime

MaxHeight

Gets or sets the max height.

public float MaxHeight { get; set; }

Property Value

float

MaxWidth

Gets or sets the max width.

public float MaxWidth { get; set; }

Property Value

float

MinWidth

Gets or sets the min width.

public float MinWidth { get; set; }

Property Value

float

ReservedWidth

Gets or sets the reserved width.

public float ReservedWidth { get; set; }

Property Value

float

VerticalOffset

Gets or sets the vertical offset.

public float VerticalOffset { get; set; }

Property Value

float

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. </t1></ioutlinechildnode></ioutlinechildnode></ioutlinechildnode></t1></ioutlinechildnode></ioutlinechildnode></ioutlinechildnode></t1></ioutlinechildnode></t1></ioutlinechildnode></t1></ioutlinechildnode></ioutlinechildnode></ioutlinechildnode></ioutlinechildnode></t1></ioutlinechildnode></ioutlinechildnode></ioutlinechildnode></ioutlinechildnode></ioutlinechildnode></ioutlinechildnode></ioutlinechildnode>