FieldToc
Overview
FieldToc is a class in Aspose.Words FOSS for .NET.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the TOC field.
This class provides 5 methods for working with FieldToc objects in .NET programs.
Available methods include: GetFieldCode, Remove, Unlink, Update, UpdatePageNumbers.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: BookmarkName, CaptionlessTableOfFiguresLabel, CustomStyles, DisplayResult, End, EntryIdentifier, and 20 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 | bool | 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 | bool | Read/Write | Gets or sets whether to use the applied paragraph outline level. |
PreserveTabs | bool | Read/Write | Gets or sets whether to preserve tab entries within table entries. |
PreserveLineBreaks | bool | Read/Write | Gets or sets whether to preserve newline characters within table entries. |
HideInWebLayout | bool | Read/Write | Gets or sets whether to hide tab leader and page numbers in Web layout view. |
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 | FieldType | Read | Gets the Microsoft Word field 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. |
IsLocked | bool | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
IsDirty | bool | 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() | Updates the page numbers for items in this table of contents. |
GetFieldCode() | Returns text between field start and field separator (or field end if there is no separator). |
Remove() | Removes the field from the document. |
Update() | Performs the field update. |
Unlink() | Performs the field unlink. |