Class OutlineOptions

Namespace: Aspose.Words.Saving
Assembly: Aspose.Words.dll (25.4.0)

Allows to specify outline options.

To learn more, visit the Save a Document documentation article.

public class OutlineOptions

Inheritance

object ← OutlineOptions

Inherited Members

object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()

Constructors

OutlineOptions()

public OutlineOptions()

Properties

BookmarksOutlineLevels

Allows to specify individual bookmarks outline level.

public BookmarksOutlineLevelCollection BookmarksOutlineLevels { get; }

Property Value

BookmarksOutlineLevelCollection

Remarks

If bookmark level is not specified in this collection then Aspose.Words.Saving.OutlineOptions.DefaultBookmarksOutlineLevel value is used.

CreateMissingOutlineLevels

Gets or sets a value determining whether or not to create missing outline levels when the document is exported.

Default value for this property is false.

public bool CreateMissingOutlineLevels { get; set; }

Property Value

bool

CreateOutlinesForHeadingsInTables

Specifies whether or not to create outlines for headings (paragraphs formatted with the Heading styles) inside tables.

public bool CreateOutlinesForHeadingsInTables { get; set; }

Property Value

bool

Remarks

Default value is false.

DefaultBookmarksOutlineLevel

Specifies the default level in the document outline at which to display Word bookmarks.

public int DefaultBookmarksOutlineLevel { get; set; }

Property Value

int

Remarks

Individual bookmarks level could be specified using Aspose.Words.Saving.OutlineOptions.BookmarksOutlineLevels property.

Specify 0 and Word bookmarks will not be displayed in the document outline. Specify 1 and Word bookmarks will be displayed in the document outline at level 1; 2 for level 2 and so on.

Default is 0. Valid range is 0 to 9.

ExpandedOutlineLevels

Specifies how many levels in the document outline to show expanded when the file is viewed.

public int ExpandedOutlineLevels { get; set; }

Property Value

int

Remarks

Note that this options will not work when saving to XPS.

Specify 0 and the document outline will be collapsed; specify 1 and the first level items in the outline will be expanded and so on.

Default is 0. Valid range is 0 to 9.

HeadingsOutlineLevels

Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline.

public int HeadingsOutlineLevels { get; set; }

Property Value

int

Remarks

Specify 0 for no headings in the outline; specify 1 for one level of headings in the outline and so on.

Default is 0. Valid range is 0 to 9.