com.aspose.words
Class OutlineOptions

java.lang.Object
    extended by com.aspose.words.OutlineOptions

public class OutlineOptions 
extends java.lang.Object

Allows to specify outline options.

Constructor Summary
OutlineOptions()
          
 
Property Getters/Setters Summary
BookmarksOutlineLevelCollectiongetBookmarksOutlineLevels()
           Allows to specify individual bookmarks outline level.
booleangetCreateMissingOutlineLevels()
voidsetCreateMissingOutlineLevels(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.

booleangetCreateOutlinesForHeadingsInTables()
voidsetCreateOutlinesForHeadingsInTables(boolean value)
           Specifies whether or not to create outlines for headings (paragraphs formatted with the Heading styles) inside tables.
intgetDefaultBookmarksOutlineLevel()
voidsetDefaultBookmarksOutlineLevel(int value)
           Specifies the default level in the document outline at which to display Word bookmarks.
intgetExpandedOutlineLevels()
voidsetExpandedOutlineLevels(int value)
           Specifies how many levels in the document outline to show expanded when the file is viewed.
intgetHeadingsOutlineLevels()
voidsetHeadingsOutlineLevels(int value)
           Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline.
 

Constructor Detail

OutlineOptions

public OutlineOptions()

Property Getters/Setters Detail

getBookmarksOutlineLevels

public BookmarksOutlineLevelCollection getBookmarksOutlineLevels()
Allows to specify individual bookmarks outline level.

If bookmark level is not specified in this collection then DefaultBookmarksOutlineLevel value is used.


getCreateMissingOutlineLevels/setCreateMissingOutlineLevels

public boolean getCreateMissingOutlineLevels() / 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.


getCreateOutlinesForHeadingsInTables/setCreateOutlinesForHeadingsInTables

public boolean getCreateOutlinesForHeadingsInTables() / 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.


getDefaultBookmarksOutlineLevel/setDefaultBookmarksOutlineLevel

public int getDefaultBookmarksOutlineLevel() / 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 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.


getExpandedOutlineLevels/setExpandedOutlineLevels

public int getExpandedOutlineLevels() / 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.

Example:

Converts a whole document to PDF with three levels in the document outline.
Document doc = new Document(getMyDir() + "Rendering.doc");

PdfSaveOptions options = new PdfSaveOptions();
options.getOutlineOptions().setHeadingsOutlineLevels(3);
options.getOutlineOptions().setExpandedOutlineLevels(1);

doc.save(getMyDir() + "Rendering.SaveToPdfWithOutline Out.pdf", options);

getHeadingsOutlineLevels/setHeadingsOutlineLevels

public int getHeadingsOutlineLevels() / 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.

Example:

Converts a whole document to PDF with three levels in the document outline.
Document doc = new Document(getMyDir() + "Rendering.doc");

PdfSaveOptions options = new PdfSaveOptions();
options.getOutlineOptions().setHeadingsOutlineLevels(3);
options.getOutlineOptions().setExpandedOutlineLevels(1);

doc.save(getMyDir() + "Rendering.SaveToPdfWithOutline Out.pdf", options);

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.