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

NameTypeAccessDescription
bookmarkNameStringRead/WriteGets or sets the name of the bookmark that marks the portion of the document used to build the table.
tableOfFiguresLabelStringRead/WriteGets or sets the name of the sequence identifier used when building a table of figures.
captionlessTableOfFiguresLabelStringRead/WriteGets or sets the name of the sequence identifier used when building a table of figures that does not include caption’s label and number.
sequenceSeparatorStringRead/WriteGets or sets the character sequence that is used to separate sequence numbers and page numbers.
entryIdentifierStringRead/WriteGets or sets a string that should match type identifiers of TC fields being included.
insertHyperlinksbooleanRead/WriteGets or sets whether to make the table of contents entries hyperlinks.
entryLevelRangeStringRead/WriteGets or sets a range of levels of the table of contents entries to be included.
pageNumberOmittingLevelRangeStringRead/WriteGets or sets a range of levels of the table of contents entries from which to omits page numbers.
headingLevelRangeStringRead/WriteGets or sets a range of heading levels to include.
entrySeparatorStringRead/WriteGets or sets a sequence of characters that separate an entry and its page number.
prefixedSequenceIdentifierStringRead/WriteGets or sets the identifier of a sequence for which a prefix should be added to the entry’s page number.
customStylesStringRead/WriteGets or sets a list of styles other than the built-in heading styles to include in the table of contents.
useParagraphOutlineLevelbooleanRead/WriteGets or sets whether to use the applied paragraph outline level.
preserveTabsbooleanRead/WriteGets or sets whether to preserve tab entries within table entries.
preserveLineBreaksbooleanRead/WriteGets or sets whether to preserve newline characters within table entries.
hideInWebLayoutbooleanRead/WriteGets or sets whether to hide tab leader and page numbers in Web layout view.
fieldCodeStringReadReturns text between field start and field separator (or field end if there is no separator).
startFieldStartReadGets the node that represents the start of the field.
separatorFieldSeparatorReadGets the node that represents the field separator.
endFieldEndReadGets the node that represents the field end.
typeintReadGets the type.
resultStringRead/WriteGets or sets text that is between the field separator and field end.
displayResultStringReadGets the text that represents the displayed field result.
lockedbooleanRead/WriteGets or sets whether the field is locked (should not recalculate its result).
dirtybooleanRead/WriteGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
formatFieldFormatReadGets a FieldFormat object that provides typed access to field’s formatting.
localeIdintRead/WriteGets or sets the LCID of the field.

Methods

SignatureDescription
updatePageNumbers() → booleanUpdates the page numbers for items in this table of contents.
getBookmarkName() → StringGets 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() → StringGets 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() → StringGets 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() → StringGets or sets the character sequence that is used to separate sequence numbers and page numbers.
setSequenceSeparator(value: String)Sets the sequence separator value.
getEntryIdentifier() → StringGets or sets a string that should match type identifiers of TC fields being included.
setEntryIdentifier(value: String)Sets the entry identifier value.
getInsertHyperlinks() → booleanGets or sets whether to make the table of contents entries hyperlinks.
setInsertHyperlinks(value: boolean)Sets the insert hyperlinks value.
getEntryLevelRange() → StringGets 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() → StringGets 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() → StringGets or sets a range of heading levels to include.
setHeadingLevelRange(value: String)Sets the heading level range value.
getEntrySeparator() → StringGets or sets a sequence of characters that separate an entry and its page number.
setEntrySeparator(value: String)Sets the entry separator value.
getPrefixedSequenceIdentifier() → StringGets 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() → StringGets 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() → booleanGets or sets whether to use the applied paragraph outline level.
setUseParagraphOutlineLevel(value: boolean)Sets the use paragraph outline level value.
getPreserveTabs() → booleanGets or sets whether to preserve tab entries within table entries.
setPreserveTabs(value: boolean)Sets the preserve tabs value.
getPreserveLineBreaks() → booleanGets or sets whether to preserve newline characters within table entries.
setPreserveLineBreaks(value: boolean)Sets the preserve line breaks value.
getHideInWebLayout() → booleanGets 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() → StringReturns text between field start and field separator (or field end if there is no separator).
getFieldCode(includeChildFieldCodes: boolean) → StringReturns text between field start and field separator (or field end if there is no separator).
remove() → NodeRemoves the field from the document.
update()Performs the field update.
update(ignoreMergeFormat: boolean)Performs a field update.
unlink() → booleanPerforms the field unlink.
getStart() → FieldStartGets the node that represents the start of the field.
getSeparator() → FieldSeparatorGets the node that represents the field separator.
getEnd() → FieldEndGets the node that represents the field end.
getType() → intReturns the type.
getResult() → StringGets or sets text that is between the field separator and field end.
setResult(value: String)Sets the result value.
getDisplayResult() → StringGets the text that represents the displayed field result.
isLocked() → booleanGets or sets whether the field is locked (should not recalculate its result).
isLocked(value: boolean)Calls isLocked(value) on this FieldToc instance.
isDirty() → booleanGets 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() → FieldFormatGets a FieldFormat object that provides typed access to field’s formatting.
getLocaleId() → intGets or sets the LCID of the field.
setLocaleId(value: int)Sets the locale id value.

See Also