FieldToc
Overview
FieldToc is a class in Aspose.Words FOSS for Java.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the TOC field.
Edition status of its 76 listed members (a property and its accessor methods are listed separately, overloads once): 76 not yet exercised by a verified example.
This class declares 53 methods for FieldToc objects in Java programs.
Available methods include: getBookmarkName, getCaptionlessTableOfFiguresLabel, getCustomStyles, getDisplayResult, getEnd, getEntryIdentifier, getEntryLevelRange, getEntrySeparator, getFieldCode, getFormat, getHeadingLevelRange, getHideInWebLayout, and 37 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: bookmarkName, captionlessTableOfFiguresLabel, customStyles, dirty, displayResult, end, and 21 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
bookmarkName | String | Read/Write | Gets or sets the name of the bookmark that marks the portion of the document used to build the table. |
tableOfFiguresLabel | String | Read/Write | Gets or sets the name of the sequence identifier used when building a table of figures. |
captionlessTableOfFiguresLabel | String | Read/Write | Gets or sets the name of the sequence identifier used when building a table of figures that does not include caption’s label and number. |
sequenceSeparator | String | Read/Write | Gets or sets the character sequence that is used to separate sequence numbers and page numbers. |
entryIdentifier | String | Read/Write | Gets or sets a string that should match type identifiers of TC fields being included. |
insertHyperlinks | boolean | Read/Write | Gets or sets whether to make the table of contents entries hyperlinks. |
entryLevelRange | String | Read/Write | Gets or sets a range of levels of the table of contents entries to be included. |
pageNumberOmittingLevelRange | String | Read/Write | Gets or sets a range of levels of the table of contents entries from which to omits page numbers. |
headingLevelRange | String | Read/Write | Gets or sets a range of heading levels to include. |
entrySeparator | String | Read/Write | Gets or sets a sequence of characters that separate an entry and its page number. |
prefixedSequenceIdentifier | String | Read/Write | Gets or sets the identifier of a sequence for which a prefix should be added to the entry’s page number. |
customStyles | String | Read/Write | Gets or sets a list of styles other than the built-in heading styles to include in the table of contents. |
useParagraphOutlineLevel | boolean | Read/Write | Gets or sets whether to use the applied paragraph outline level. |
preserveTabs | boolean | Read/Write | Gets or sets whether to preserve tab entries within table entries. |
preserveLineBreaks | boolean | Read/Write | Gets or sets whether to preserve newline characters within table entries. |
hideInWebLayout | boolean | Read/Write | Gets or sets whether to hide tab leader and page numbers in Web layout view. |
fieldCode | String | Read | Returns text between field start and field separator (or field end if there is no separator). |
start | FieldStart | Read | Gets the node that represents the start of the field. |
separator | FieldSeparator | Read | Gets the node that represents the field separator. |
end | FieldEnd | Read | Gets the node that represents the field end. |
type | int | Read | Gets the type. |
result | String | Read/Write | Gets or sets text that is between the field separator and field end. |
displayResult | String | Read | Gets the text that represents the displayed field result. |
locked | boolean | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
dirty | boolean | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
localeId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
updatePageNumbers() → boolean | Updates the page numbers for items in this table of contents. |
getBookmarkName() → String | Gets or sets the name of the bookmark that marks the portion of the document used to build the table. |
setBookmarkName(value: String) | Sets the bookmark name value. |
getTableOfFiguresLabel() → String | Gets or sets the name of the sequence identifier used when building a table of figures. |
setTableOfFiguresLabel(value: String) | Sets the table of figures label value. |
getCaptionlessTableOfFiguresLabel() → String | Gets or sets the name of the sequence identifier used when building a table of figures that does not include caption’s label and number. |
setCaptionlessTableOfFiguresLabel(value: String) | Sets the captionless table of figures label value. |
getSequenceSeparator() → String | Gets or sets the character sequence that is used to separate sequence numbers and page numbers. |
setSequenceSeparator(value: String) | Sets the sequence separator value. |
getEntryIdentifier() → String | Gets or sets a string that should match type identifiers of TC fields being included. |
setEntryIdentifier(value: String) | Sets the entry identifier value. |
getInsertHyperlinks() → boolean | Gets or sets whether to make the table of contents entries hyperlinks. |
setInsertHyperlinks(value: boolean) | Sets the insert hyperlinks value. |
getEntryLevelRange() → String | Gets or sets a range of levels of the table of contents entries to be included. |
setEntryLevelRange(value: String) | Sets the entry level range value. |
getPageNumberOmittingLevelRange() → String | Gets or sets a range of levels of the table of contents entries from which to omits page numbers. |
setPageNumberOmittingLevelRange(value: String) | Sets the page number omitting level range value. |
getHeadingLevelRange() → String | Gets or sets a range of heading levels to include. |
setHeadingLevelRange(value: String) | Sets the heading level range value. |
getEntrySeparator() → String | Gets or sets a sequence of characters that separate an entry and its page number. |
setEntrySeparator(value: String) | Sets the entry separator value. |
getPrefixedSequenceIdentifier() → String | Gets or sets the identifier of a sequence for which a prefix should be added to the entry’s page number. |
setPrefixedSequenceIdentifier(value: String) | Sets the prefixed sequence identifier value. |
getCustomStyles() → String | Gets or sets a list of styles other than the built-in heading styles to include in the table of contents. |
setCustomStyles(value: String) | Sets the custom styles value. |
getUseParagraphOutlineLevel() → boolean | Gets or sets whether to use the applied paragraph outline level. |
setUseParagraphOutlineLevel(value: boolean) | Sets the use paragraph outline level value. |
getPreserveTabs() → boolean | Gets or sets whether to preserve tab entries within table entries. |
setPreserveTabs(value: boolean) | Sets the preserve tabs value. |
getPreserveLineBreaks() → boolean | Gets or sets whether to preserve newline characters within table entries. |
setPreserveLineBreaks(value: boolean) | Sets the preserve line breaks value. |
getHideInWebLayout() → boolean | Gets or sets whether to hide tab leader and page numbers in Web layout view. |
setHideInWebLayout(value: boolean) | Sets the hide in web layout value. |
getFieldCode() → String | Returns text between field start and field separator (or field end if there is no separator). |
getFieldCode(includeChildFieldCodes: boolean) → String | Returns text between field start and field separator (or field end if there is no separator). |
remove() → Node | Removes the field from the document. |
update() | Performs the field update. |
update(ignoreMergeFormat: boolean) | Performs a field update. |
unlink() → boolean | Performs the field unlink. |
getStart() → FieldStart | Gets the node that represents the start of the field. |
getSeparator() → FieldSeparator | Gets the node that represents the field separator. |
getEnd() → FieldEnd | Gets the node that represents the field end. |
getType() → int | Returns the type. |
getResult() → String | Gets or sets text that is between the field separator and field end. |
setResult(value: String) | Sets the result value. |
getDisplayResult() → String | Gets the text that represents the displayed field result. |
isLocked() → boolean | Gets or sets whether the field is locked (should not recalculate its result). |
isLocked(value: boolean) | Calls isLocked(value) on this FieldToc instance. |
isDirty() → boolean | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
isDirty(value: boolean) | Calls isDirty(value) on this FieldToc instance. |
getFormat() → FieldFormat | Gets a FieldFormat object that provides typed access to field’s formatting. |
getLocaleId() → int | Gets or sets the LCID of the field. |
setLocaleId(value: int) | Sets the locale id value. |