FieldToc (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Field
- - com.aspose.words.FieldToc

```
public class FieldToc
extends Field
```
Implements the TOC field. Builds a table of contents (which can also be a table of figures) using the entries specified by TC fields, their heading levels, and specified styles, and inserts that table at this place in the document.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAreCustomStylesSpecified()`
`java.lang.String`	`getBookmarkName()` Gets the name of the bookmark that marks the portion of the document used to build the table.
`java.lang.String`	`getCaptionlessTableOfFiguresLabel()` Gets the name of the sequence identifier used when building a table of figures that does not include caption's label and number.
`java.lang.String`	`getCustomStyles()` Gets a list of styles other than the built-in heading styles to include in the table of contents.
`java.lang.String`	`getEntryIdentifier()` Gets a string that should match type identifiers of TC fields being included.
`java.lang.String`	`getEntryLevelRange()` Gets a range of levels of the table of contents entries to be included.
`java.lang.String`	`getEntrySeparator()` Gets a sequence of characters that separate an entry and its page number.
`int`	`getEntryTypeCore()`
`java.lang.String`	`getHeadingLevelRange()` Gets a range of heading levels to include.
`boolean`	`getHideInWebLayout()` Gets whether to hide tab leader and page numbers in Web layout view.
`boolean`	`getIncludeRefDocFields()`
`boolean`	`getIncludeTocEntryFields()`
`boolean`	`getInsertHyperlinks()` Gets whether to make the table of contents entries hyperlinks.
`int`	`getLevelForCustomStyle(Paragraph paragraph, Style style)`
`java.lang.String`	`getPageNumberOmittingLevelRange()` Gets a range of levels of the table of contents entries from which to omits page numbers.
`java.lang.String`	`getPrefixedSequenceIdentifier()` Gets the identifier of a sequence for which a prefix should be added to the entry's page number.
`boolean`	`getPreserveLineBreaks()` Gets whether to preserve newline characters within table entries.
`boolean`	`getPreserveTabs()` Gets whether to preserve tab entries within table entries.
`Bookmark`	`getRangeBookmark()`
`java.lang.String`	`getSequenceSeparator()` Gets the character sequence that is used to separate sequence numbers and page numbers.
`boolean`	`getSkipTables()`
`int`	`getSwitchType(java.lang.String switchName)`
`java.lang.String`	`getTableOfFiguresLabel()` Gets the name of the sequence identifier used when building a table of figures.
`boolean`	`getUseParagraphOutlineLevel()` Gets whether to use the applied paragraph outline level.
`boolean`	`isBookmarkRangeSpecified()`
`boolean`	`isEntryLevelRangeSpecified()`
`boolean`	`isHeadingLevelRangeSpecified()`
`boolean`	`isTableOfFigures()`
`void`	`setBookmarkName(java.lang.String value)` Sets the name of the bookmark that marks the portion of the document used to build the table.
`void`	`setCaptionlessTableOfFiguresLabel(java.lang.String value)` Sets the name of the sequence identifier used when building a table of figures that does not include caption's label and number.
`void`	`setCustomStyles(java.lang.String value)` Sets a list of styles other than the built-in heading styles to include in the table of contents.
`void`	`setEntryIdentifier(java.lang.String value)` Sets a string that should match type identifiers of TC fields being included.
`void`	`setEntryLevelRange(java.lang.String value)` Sets a range of levels of the table of contents entries to be included.
`void`	`setEntrySeparator(java.lang.String value)` Sets a sequence of characters that separate an entry and its page number.
`void`	`setHeadingLevelRange(java.lang.String value)` Sets a range of heading levels to include.
`void`	`setHideInWebLayout(boolean value)` Sets whether to hide tab leader and page numbers in Web layout view.
`void`	`setInsertHyperlinks(boolean value)` Sets whether to make the table of contents entries hyperlinks.
`void`	`setPageNumberOmittingLevelRange(java.lang.String value)` Sets a range of levels of the table of contents entries from which to omits page numbers.
`void`	`setPrefixedSequenceIdentifier(java.lang.String value)` Sets the identifier of a sequence for which a prefix should be added to the entry's page number.
`void`	`setPreserveLineBreaks(boolean value)` Sets whether to preserve newline characters within table entries.
`void`	`setPreserveTabs(boolean value)` Sets whether to preserve tab entries within table entries.
`void`	`setSequenceSeparator(java.lang.String value)` Sets the character sequence that is used to separate sequence numbers and page numbers.
`void`	`setTableOfFiguresLabel(java.lang.String value)` Sets the name of the sequence identifier used when building a table of figures.
`void`	`setUseParagraphOutlineLevel(boolean value)` Sets whether to use the applied paragraph outline level.
`boolean`	`updatePageNumbers()` Updates the page numbers for items in this table of contents.

Methods inherited from class com.aspose.words.Field
getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - updatePageNumbers
```
public boolean updatePageNumbers()
                          throws java.lang.Exception
```
    Updates the page numbers for items in this table of contents.
    
    Returns:
    
    True if the operation is successful. If any of the related TOC bookmarks was removed, false will be returned.
    
    Throws:
    
    java.lang.Exception
  - getLevelForCustomStyle
```
public int getLevelForCustomStyle(Paragraph paragraph,
                                  Style style)
```
  - getSkipTables
```
public boolean getSkipTables()
```
  - getIncludeRefDocFields
```
public boolean getIncludeRefDocFields()
```
  - getSwitchType
```
public int getSwitchType(java.lang.String switchName)
```
  - getIncludeTocEntryFields
```
public boolean getIncludeTocEntryFields()
```
  - getEntryTypeCore
```
public int getEntryTypeCore()
```
  - isHeadingLevelRangeSpecified
```
public boolean isHeadingLevelRangeSpecified()
```
  - isEntryLevelRangeSpecified
```
public boolean isEntryLevelRangeSpecified()
```
  - getAreCustomStylesSpecified
```
public boolean getAreCustomStylesSpecified()
```
  - isTableOfFigures
```
public boolean isTableOfFigures()
```
  - getBookmarkName
```
public java.lang.String getBookmarkName()
```
    Gets the name of the bookmark that marks the portion of the document used to build the table.
    
    Returns:
    
    The name of the bookmark that marks the portion of the document used to build the table.
  - setBookmarkName
```
public void setBookmarkName(java.lang.String value)
                     throws java.lang.Exception
```
    Sets the name of the bookmark that marks the portion of the document used to build the table.
    
    Parameters:
    
    value - The name of the bookmark that marks the portion of the document used to build the table.
    
    Throws:
    
    java.lang.Exception
  - getTableOfFiguresLabel
```
public java.lang.String getTableOfFiguresLabel()
```
    Gets the name of the sequence identifier used when building a table of figures.
    
    Returns:
    
    The name of the sequence identifier used when building a table of figures.
  - setTableOfFiguresLabel
```
public void setTableOfFiguresLabel(java.lang.String value)
                            throws java.lang.Exception
```
    Sets the name of the sequence identifier used when building a table of figures.
    
    Parameters:
    
    value - The name of the sequence identifier used when building a table of figures.
    
    Throws:
    
    java.lang.Exception
  - getCaptionlessTableOfFiguresLabel
```
public java.lang.String getCaptionlessTableOfFiguresLabel()
```
    Gets the name of the sequence identifier used when building a table of figures that does not include caption's label and number.
    
    Returns:
    
    The name of the sequence identifier used when building a table of figures that does not include caption's label and number.
  - setCaptionlessTableOfFiguresLabel
```
public void setCaptionlessTableOfFiguresLabel(java.lang.String value)
                                       throws java.lang.Exception
```
    Sets the name of the sequence identifier used when building a table of figures that does not include caption's label and number.
    
    Parameters:
    
    value - The name of the sequence identifier used when building a table of figures that does not include caption's label and number.
    
    Throws:
    
    java.lang.Exception
  - isBookmarkRangeSpecified
```
public boolean isBookmarkRangeSpecified()
```
  - getRangeBookmark
```
public Bookmark getRangeBookmark()
                          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getSequenceSeparator
```
public java.lang.String getSequenceSeparator()
```
    Gets the character sequence that is used to separate sequence numbers and page numbers.
    
    Returns:
    
    The character sequence that is used to separate sequence numbers and page numbers.
  - setSequenceSeparator
```
public void setSequenceSeparator(java.lang.String value)
                          throws java.lang.Exception
```
    Sets the character sequence that is used to separate sequence numbers and page numbers.
    
    Parameters:
    
    value - The character sequence that is used to separate sequence numbers and page numbers.
    
    Throws:
    
    java.lang.Exception
  - getEntryIdentifier
```
public java.lang.String getEntryIdentifier()
```
    Gets a string that should match type identifiers of TC fields being included.
    
    Returns:
    
    A string that should match type identifiers of TC fields being included.
  - setEntryIdentifier
```
public void setEntryIdentifier(java.lang.String value)
                        throws java.lang.Exception
```
    Sets a string that should match type identifiers of TC fields being included.
    
    Parameters:
    
    value - A string that should match type identifiers of TC fields being included.
    
    Throws:
    
    java.lang.Exception
  - getInsertHyperlinks
```
public boolean getInsertHyperlinks()
```
    Gets whether to make the table of contents entries hyperlinks.
    
    Returns:
    
    Whether to make the table of contents entries hyperlinks.
  - setInsertHyperlinks
```
public void setInsertHyperlinks(boolean value)
                         throws java.lang.Exception
```
    Sets whether to make the table of contents entries hyperlinks.
    
    Parameters:
    
    value - Whether to make the table of contents entries hyperlinks.
    
    Throws:
    
    java.lang.Exception
  - getEntryLevelRange
```
public java.lang.String getEntryLevelRange()
```
    Gets a range of levels of the table of contents entries to be included.
    
    Returns:
    
    A range of levels of the table of contents entries to be included.
  - setEntryLevelRange
```
public void setEntryLevelRange(java.lang.String value)
                        throws java.lang.Exception
```
    Sets a range of levels of the table of contents entries to be included.
    
    Parameters:
    
    value - A range of levels of the table of contents entries to be included.
    
    Throws:
    
    java.lang.Exception
  - getPageNumberOmittingLevelRange
```
public java.lang.String getPageNumberOmittingLevelRange()
```
    Gets a range of levels of the table of contents entries from which to omits page numbers.
    
    Returns:
    
    A range of levels of the table of contents entries from which to omits page numbers.
  - setPageNumberOmittingLevelRange
```
public void setPageNumberOmittingLevelRange(java.lang.String value)
                                     throws java.lang.Exception
```
    Sets a range of levels of the table of contents entries from which to omits page numbers.
    
    Parameters:
    
    value - A range of levels of the table of contents entries from which to omits page numbers.
    
    Throws:
    
    java.lang.Exception
  - getHeadingLevelRange
```
public java.lang.String getHeadingLevelRange()
```
    Gets a range of heading levels to include.
    
    Returns:
    
    A range of heading levels to include.
  - setHeadingLevelRange
```
public void setHeadingLevelRange(java.lang.String value)
                          throws java.lang.Exception
```
    Sets a range of heading levels to include.
    
    Parameters:
    
    value - A range of heading levels to include.
    
    Throws:
    
    java.lang.Exception
  - getEntrySeparator
```
public java.lang.String getEntrySeparator()
```
    Gets a sequence of characters that separate an entry and its page number.
    
    Returns:
    
    A sequence of characters that separate an entry and its page number.
  - setEntrySeparator
```
public void setEntrySeparator(java.lang.String value)
                       throws java.lang.Exception
```
    Sets a sequence of characters that separate an entry and its page number.
    
    Parameters:
    
    value - A sequence of characters that separate an entry and its page number.
    
    Throws:
    
    java.lang.Exception
  - getPrefixedSequenceIdentifier
```
public java.lang.String getPrefixedSequenceIdentifier()
```
    Gets the identifier of a sequence for which a prefix should be added to the entry's page number.
    
    Returns:
    
    The identifier of a sequence for which a prefix should be added to the entry's page number.
  - setPrefixedSequenceIdentifier
```
public void setPrefixedSequenceIdentifier(java.lang.String value)
                                   throws java.lang.Exception
```
    Sets the identifier of a sequence for which a prefix should be added to the entry's page number.
    
    Parameters:
    
    value - The identifier of a sequence for which a prefix should be added to the entry's page number.
    
    Throws:
    
    java.lang.Exception
  - getCustomStyles
```
public java.lang.String getCustomStyles()
```
    Gets a list of styles other than the built-in heading styles to include in the table of contents.
    
    Returns:
    
    A list of styles other than the built-in heading styles to include in the table of contents.
  - setCustomStyles
```
public void setCustomStyles(java.lang.String value)
                     throws java.lang.Exception
```
    Sets a list of styles other than the built-in heading styles to include in the table of contents.
    
    Parameters:
    
    value - A list of styles other than the built-in heading styles to include in the table of contents.
    
    Throws:
    
    java.lang.Exception
  - getUseParagraphOutlineLevel
```
public boolean getUseParagraphOutlineLevel()
```
    Gets whether to use the applied paragraph outline level.
    
    Returns:
    
    Whether to use the applied paragraph outline level.
  - setUseParagraphOutlineLevel
```
public void setUseParagraphOutlineLevel(boolean value)
                                 throws java.lang.Exception
```
    Sets whether to use the applied paragraph outline level.
    
    Parameters:
    
    value - Whether to use the applied paragraph outline level.
    
    Throws:
    
    java.lang.Exception
  - getPreserveTabs
```
public boolean getPreserveTabs()
```
    Gets whether to preserve tab entries within table entries.
    
    Returns:
    
    Whether to preserve tab entries within table entries.
  - setPreserveTabs
```
public void setPreserveTabs(boolean value)
                     throws java.lang.Exception
```
    Sets whether to preserve tab entries within table entries.
    
    Parameters:
    
    value - Whether to preserve tab entries within table entries.
    
    Throws:
    
    java.lang.Exception
  - getPreserveLineBreaks
```
public boolean getPreserveLineBreaks()
```
    Gets whether to preserve newline characters within table entries.
    
    Returns:
    
    Whether to preserve newline characters within table entries.
  - setPreserveLineBreaks
```
public void setPreserveLineBreaks(boolean value)
                           throws java.lang.Exception
```
    Sets whether to preserve newline characters within table entries.
    
    Parameters:
    
    value - Whether to preserve newline characters within table entries.
    
    Throws:
    
    java.lang.Exception
  - getHideInWebLayout
```
public boolean getHideInWebLayout()
```
    Gets whether to hide tab leader and page numbers in Web layout view.
    
    Returns:
    
    Whether to hide tab leader and page numbers in Web layout view.
  - setHideInWebLayout
```
public void setHideInWebLayout(boolean value)
                        throws java.lang.Exception
```
    Sets whether to hide tab leader and page numbers in Web layout view.
    
    Parameters:
    
    value - Whether to hide tab leader and page numbers in Web layout view.
    
    Throws:
    
    java.lang.Exception

Class FieldToc

Method Summary

Methods inherited from class com.aspose.words.Field

Methods inherited from class java.lang.Object

Method Detail

updatePageNumbers

getLevelForCustomStyle

getSkipTables

getIncludeRefDocFields

getSwitchType

getIncludeTocEntryFields

getEntryTypeCore

isHeadingLevelRangeSpecified

isEntryLevelRangeSpecified

getAreCustomStylesSpecified

isTableOfFigures

getBookmarkName

setBookmarkName

getTableOfFiguresLabel

setTableOfFiguresLabel

getCaptionlessTableOfFiguresLabel

setCaptionlessTableOfFiguresLabel

isBookmarkRangeSpecified

getRangeBookmark

getSequenceSeparator

setSequenceSeparator

getEntryIdentifier

setEntryIdentifier

getInsertHyperlinks

setInsertHyperlinks

getEntryLevelRange

setEntryLevelRange

getPageNumberOmittingLevelRange

setPageNumberOmittingLevelRange

getHeadingLevelRange

setHeadingLevelRange

getEntrySeparator

setEntrySeparator

getPrefixedSequenceIdentifier

setPrefixedSequenceIdentifier

getCustomStyles

setCustomStyles

getUseParagraphOutlineLevel

setUseParagraphOutlineLevel

getPreserveTabs

setPreserveTabs

getPreserveLineBreaks

setPreserveLineBreaks

getHideInWebLayout

setHideInWebLayout