com.aspose.words

Class OutlineOptions

java.lang.Object

com.aspose.words.OutlineOptions

public class OutlineOptions
extends java.lang.Object

Allows to specify outline options.

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

Method Summary

Modifier and Type	Method and Description
BookmarksOutlineLevelCollection	getBookmarksOutlineLevels() Allows to specify individual bookmarks outline level.
boolean	getCreateMissingOutlineLevels() Gets or sets a value determining whether or not to create missing outline levels when the document is exported.
boolean	getCreateOutlinesForHeadingsInTables() Specifies whether or not to create outlines for headings (paragraphs formatted with the Heading styles) inside tables.
int	getDefaultBookmarksOutlineLevel() Specifies the default level in the document outline at which to display Word bookmarks.
int	getExpandedOutlineLevels() Specifies how many levels in the document outline to show expanded when the file is viewed.
int	getHeadingsOutlineLevels() Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline.
void	setCreateMissingOutlineLevels(boolean value) Gets or sets a value determining whether or not to create missing outline levels when the document is exported.
void	setCreateOutlinesForHeadingsInTables(boolean value) Specifies whether or not to create outlines for headings (paragraphs formatted with the Heading styles) inside tables.
void	setDefaultBookmarksOutlineLevel(int value) Specifies the default level in the document outline at which to display Word bookmarks.
void	setExpandedOutlineLevels(int value) Specifies how many levels in the document outline to show expanded when the file is viewed.
void	setHeadingsOutlineLevels(int value) Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCreateMissingOutlineLevels

public boolean getCreateMissingOutlineLevels()

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.

Returns:

The corresponding boolean value.

setCreateMissingOutlineLevels

public void setCreateMissingOutlineLevels(boolean value)

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.

Parameters:

value - The corresponding boolean value.

getHeadingsOutlineLevels

public int getHeadingsOutlineLevels()

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

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.

Returns:

The corresponding int value.

setHeadingsOutlineLevels

public void setHeadingsOutlineLevels(int value)

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

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.

Parameters:

value - The corresponding int value.

getExpandedOutlineLevels

public int getExpandedOutlineLevels()

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

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.

Returns:

The corresponding int value.

setExpandedOutlineLevels

public void setExpandedOutlineLevels(int value)

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

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.

Parameters:

value - The corresponding int value.

getDefaultBookmarksOutlineLevel

public int getDefaultBookmarksOutlineLevel()

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

Individual bookmarks level could be specified using getBookmarksOutlineLevels() 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.

Returns:

The corresponding int value.

setDefaultBookmarksOutlineLevel

public void setDefaultBookmarksOutlineLevel(int value)

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

Individual bookmarks level could be specified using getBookmarksOutlineLevels() 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.

Parameters:

value - The corresponding int value.

getBookmarksOutlineLevels

public BookmarksOutlineLevelCollection getBookmarksOutlineLevels()

Allows to specify individual bookmarks outline level.

If bookmark level is not specified in this collection then getDefaultBookmarksOutlineLevel() / setDefaultBookmarksOutlineLevel(int) value is used.

Returns:

The corresponding BookmarksOutlineLevelCollection value.

getCreateOutlinesForHeadingsInTables

public boolean getCreateOutlinesForHeadingsInTables()

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

Default value is false.

Returns:

The corresponding boolean value.

setCreateOutlinesForHeadingsInTables

public void setCreateOutlinesForHeadingsInTables(boolean value)

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

Default value is false.

Parameters:

value - The corresponding boolean value.