OutlineOptions
Inheritance: java.lang.Object
public class OutlineOptions
Allows to specify outline options.
To learn more, visit the Save a Document documentation article.
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getBookmarksOutlineLevels() | Allows to specify individual bookmarks outline level. |
| getClass() | |
| getCreateMissingOutlineLevels() | Gets or sets a value determining whether or not to create missing outline levels when the document is exported. |
| getCreateOutlinesForHeadingsInTables() | Specifies whether or not to create outlines for headings (paragraphs formatted with the Heading styles) inside tables. |
| getDefaultBookmarksOutlineLevel() | Specifies the default level in the document outline at which to display Word bookmarks. |
| getExpandedOutlineLevels() | Specifies how many levels in the document outline to show expanded when the file is viewed. |
| getHeadingsOutlineLevels() | Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setCreateMissingOutlineLevels(boolean value) | Gets or sets a value determining whether or not to create missing outline levels when the document is exported. |
| setCreateOutlinesForHeadingsInTables(boolean value) | Specifies whether or not to create outlines for headings (paragraphs formatted with the Heading styles) inside tables. |
| setDefaultBookmarksOutlineLevel(int value) | Specifies the default level in the document outline at which to display Word bookmarks. |
| setExpandedOutlineLevels(int value) | Specifies how many levels in the document outline to show expanded when the file is viewed. |
| setHeadingsOutlineLevels(int value) | Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
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: BookmarksOutlineLevelCollection - The corresponding BookmarksOutlineLevelCollection value.
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
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: boolean - The corresponding boolean 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: boolean - The corresponding boolean 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: int - 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: int - The corresponding int 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: int - The corresponding int value.
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setCreateMissingOutlineLevels(boolean value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setCreateOutlinesForHeadingsInTables(boolean value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setDefaultBookmarksOutlineLevel(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. |
setExpandedOutlineLevels(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. |
setHeadingsOutlineLevels(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |
