FieldToc class
FieldToc class
Implements the TOC field. To learn more, visit the Working with Fields documentation article.
Remarks
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.
Constructors
| Name | Description |
|---|---|
| FieldToc() | The default constructor. |
Properties
| Name | Description |
|---|---|
| bookmarkName | Gets or sets the name of the bookmark that marks the portion of the document used to build the table. |
| captionlessTableOfFiguresLabel | 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. |
| customStyles | Gets or sets a list of styles other than the built-in heading styles to include in the table of contents. |
| displayResult | Gets the text that represents the displayed field result. (Inherited from Field) |
| end | Gets the node that represents the field end. (Inherited from Field) |
| entryIdentifier | Gets or sets a string that should match type identifiers of TC fields being included. |
| entryLevelRange | Gets or sets a range of levels of the table of contents entries to be included. |
| entrySeparator | Gets or sets a sequence of characters that separate an entry and its page number. |
| format | Gets a FieldFormat object that provides typed access to field’s formatting. (Inherited from Field) |
| headingLevelRange | Gets or sets a range of heading levels to include. |
| hideInWebLayout | Gets or sets whether to hide tab leader and page numbers in Web layout view. |
| insertHyperlinks | Gets or sets whether to make the table of contents entries hyperlinks. |
| isDirty | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. (Inherited from Field) |
| isLocked | Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field) |
| localeId | Gets or sets the LCID of the field. (Inherited from Field) |
| pageNumberOmittingLevelRange | Gets or sets a range of levels of the table of contents entries from which to omits page numbers. |
| prefixedSequenceIdentifier | Gets or sets the identifier of a sequence for which a prefix should be added to the entry’s page number. |
| preserveLineBreaks | Gets or sets whether to preserve newline characters within table entries. |
| preserveTabs | Gets or sets whether to preserve tab entries within table entries. |
| result | Gets or sets text that is between the field separator and field end. (Inherited from Field) |
| separator | Gets the node that represents the field separator. Can be null.(Inherited from Field) |
| sequenceSeparator | Gets or sets the character sequence that is used to separate sequence numbers and page numbers. |
| start | Gets the node that represents the start of the field. (Inherited from Field) |
| tableOfFiguresLabel | Gets or sets the name of the sequence identifier used when building a table of figures. |
| type | Gets the Microsoft Word field type. (Inherited from Field) |
| useParagraphOutlineLevel | Gets or sets whether to use the applied paragraph outline level. |
Methods
| Name | Description |
|---|---|
| asField() | (Inherited from Field) |
| asFieldAddIn() | Cast field to FieldAddIn. (Inherited from Field) |
| asFieldAddressBlock() | Cast field to FieldAddressBlock. (Inherited from Field) |
| asFieldAdvance() | Cast field to FieldAdvance. (Inherited from Field) |
| asFieldAsk() | Cast field to FieldAsk. (Inherited from Field) |
| asFieldAuthor() | Cast field to FieldAuthor. (Inherited from Field) |
| asFieldAutoNum() | Cast field to FieldAutoNum. (Inherited from Field) |
| asFieldAutoNumLgl() | Cast field to FieldAutoNumLgl. (Inherited from Field) |
| asFieldAutoNumOut() | Cast field to FieldAutoNumOut. (Inherited from Field) |
| asFieldAutoText() | Cast field to FieldAutoText. (Inherited from Field) |
| asFieldAutoTextList() | Cast field to FieldAutoTextList. (Inherited from Field) |
| asFieldBarcode() | Cast field to FieldBarcode. (Inherited from Field) |
| asFieldBibliography() | Cast field to FieldBibliography. (Inherited from Field) |
| asFieldBidiOutline() | Cast field to FieldBidiOutline. (Inherited from Field) |
| asFieldCitation() | Cast field to FieldCitation. (Inherited from Field) |
| asFieldComments() | Cast field to FieldComments. (Inherited from Field) |
| asFieldCompare() | Cast field to FieldCompare. (Inherited from Field) |
| asFieldCreateDate() | Cast field to FieldCreateDate. (Inherited from Field) |
| asFieldData() | Cast field to FieldData. (Inherited from Field) |
| asFieldDatabase() | Cast field to FieldDatabase. (Inherited from Field) |
| asFieldDate() | Cast field to FieldDate. (Inherited from Field) |
| asFieldDde() | Cast field to FieldDde. (Inherited from Field) |
| asFieldDdeAuto() | Cast field to FieldDdeAuto. (Inherited from Field) |
| asFieldDisplayBarcode() | Cast field to FieldDisplayBarcode. (Inherited from Field) |
| asFieldDocProperty() | Cast field to FieldDocProperty. (Inherited from Field) |
| asFieldDocVariable() | Cast field to FieldDocVariable. (Inherited from Field) |
| asFieldEQ() | Cast field to FieldEQ. (Inherited from Field) |
| asFieldEditTime() | Cast field to FieldEditTime. (Inherited from Field) |
| asFieldEmbed() | Cast field to FieldEmbed. (Inherited from Field) |
| asFieldFileName() | Cast field to FieldFileName. (Inherited from Field) |
| asFieldFileSize() | Cast field to FieldFileSize. (Inherited from Field) |
| asFieldFillIn() | Cast field to FieldFillIn. (Inherited from Field) |
| asFieldFootnoteRef() | Cast field to FieldFootnoteRef. (Inherited from Field) |
| asFieldFormCheckBox() | Cast field to FieldFormCheckBox. (Inherited from Field) |
| asFieldFormDropDown() | Cast field to FieldFormDropDown. (Inherited from Field) |
| asFieldFormText() | Cast field to FieldFormText. (Inherited from Field) |
| asFieldFormula() | Cast field to FieldFormula. (Inherited from Field) |
| asFieldGlossary() | Cast field to FieldGlossary. (Inherited from Field) |
| asFieldGoToButton() | Cast field to FieldGoToButton. (Inherited from Field) |
| asFieldGreetingLine() | Cast field to FieldGreetingLine. (Inherited from Field) |
| asFieldHyperlink() | Cast field to FieldHyperlink. (Inherited from Field) |
| asFieldIf() | Cast field to FieldIf. (Inherited from Field) |
| asFieldImport() | Cast field to FieldImport. (Inherited from Field) |
| asFieldInclude() | Cast field to FieldInclude. (Inherited from Field) |
| asFieldIncludePicture() | Cast field to FieldIncludePicture. (Inherited from Field) |
| asFieldIncludeText() | Cast field to FieldIncludeText. (Inherited from Field) |
| asFieldIndex() | Cast field to FieldIndex. (Inherited from Field) |
| asFieldInfo() | Cast field to FieldInfo. (Inherited from Field) |
| asFieldKeywords() | Cast field to FieldKeywords. (Inherited from Field) |
| asFieldLastSavedBy() | Cast field to FieldLastSavedBy. (Inherited from Field) |
| asFieldLink() | Cast field to FieldLink. (Inherited from Field) |
| asFieldListNum() | Cast field to FieldListNum. (Inherited from Field) |
| asFieldMacroButton() | Cast field to FieldMacroButton. (Inherited from Field) |
| asFieldMergeBarcode() | Cast field to FieldMergeBarcode. (Inherited from Field) |
| asFieldMergeField() | Cast field to FieldMergeField. (Inherited from Field) |
| asFieldMergeRec() | Cast field to FieldMergeRec. (Inherited from Field) |
| asFieldMergeSeq() | Cast field to FieldMergeSeq. (Inherited from Field) |
| asFieldNext() | Cast field to FieldNext. (Inherited from Field) |
| asFieldNextIf() | Cast field to FieldNextIf. (Inherited from Field) |
| asFieldNoteRef() | Cast field to FieldNoteRef. (Inherited from Field) |
| asFieldNumChars() | Cast field to FieldNumChars. (Inherited from Field) |
| asFieldNumPages() | Cast field to FieldNumPages. (Inherited from Field) |
| asFieldNumWords() | Cast field to FieldNumWords. (Inherited from Field) |
| asFieldOcx() | Cast field to FieldOcx. (Inherited from Field) |
| asFieldPage() | Cast field to FieldPage. (Inherited from Field) |
| asFieldPageRef() | Cast field to FieldPageRef. (Inherited from Field) |
| asFieldPrint() | Cast field to FieldPrint. (Inherited from Field) |
| asFieldPrintDate() | Cast field to FieldPrintDate. (Inherited from Field) |
| asFieldPrivate() | Cast field to FieldPrivate. (Inherited from Field) |
| asFieldQuote() | Cast field to FieldQuote. (Inherited from Field) |
| asFieldRD() | Cast field to FieldRD. (Inherited from Field) |
| asFieldRef() | Cast field to FieldRef. (Inherited from Field) |
| asFieldRevNum() | Cast field to FieldRevNum. (Inherited from Field) |
| asFieldSaveDate() | Cast field to FieldSaveDate. (Inherited from Field) |
| asFieldSection() | Cast field to FieldSection. (Inherited from Field) |
| asFieldSectionPages() | Cast field to FieldSectionPages. (Inherited from Field) |
| asFieldSeq() | Cast field to FieldSeq. (Inherited from Field) |
| asFieldSet() | Cast field to FieldSet. (Inherited from Field) |
| asFieldShape() | Cast field to FieldShape. (Inherited from Field) |
| asFieldSkipIf() | Cast field to FieldSkipIf. (Inherited from Field) |
| asFieldStyleRef() | Cast field to FieldStyleRef. (Inherited from Field) |
| asFieldSubject() | Cast field to FieldSubject. (Inherited from Field) |
| asFieldSymbol() | Cast field to FieldSymbol. (Inherited from Field) |
| asFieldTA() | Cast field to FieldTA. (Inherited from Field) |
| asFieldTC() | Cast field to FieldTC. (Inherited from Field) |
| asFieldTemplate() | Cast field to FieldTemplate. (Inherited from Field) |
| asFieldTime() | Cast field to FieldTime. (Inherited from Field) |
| asFieldTitle() | Cast field to FieldTitle. (Inherited from Field) |
| asFieldToa() | Cast field to FieldToa. (Inherited from Field) |
| asFieldToc() | Cast field to FieldToc. (Inherited from Field) |
| asFieldUnknown() | Cast field to FieldUnknown. (Inherited from Field) |
| asFieldUserAddress() | Cast field to FieldUserAddress. (Inherited from Field) |
| asFieldUserInitials() | Cast field to FieldUserInitials. (Inherited from Field) |
| asFieldUserName() | Cast field to FieldUserName. (Inherited from Field) |
| asFieldXE() | Cast field to FieldXE. (Inherited from Field) |
| getFieldCode() | Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. (Inherited from Field) |
| getFieldCode(includeChildFieldCodes) | Returns text between field start and field separator (or field end if there is no separator). (Inherited from Field) |
| remove() | Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.(Inherited from Field) |
| unlink() | Performs the field unlink. (Inherited from Field) |
| update() | Performs the field update. Throws if the field is being updated already. (Inherited from Field) |
| update(ignoreMergeFormat) | Performs a field update. Throws if the field is being updated already. (Inherited from Field) |
| updatePageNumbers() | Updates the page numbers for items in this table of contents. |
See Also
- module Aspose.Words.Fields
- class Field