Word.TableOfContents class
Represents a table of contents in a Word document.
- Extends
Remarks
Properties
| additional |
Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection. |
| are |
Specifies whether built-in heading styles are used for the table of contents. |
| are |
Specifies whether Table of Contents Entry (TC) fields are included in the table of contents. |
| are |
Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. |
| are |
Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. |
| are |
Specifies whether page numbers are included in the table of contents. |
| are |
Specifies whether page numbers are aligned with the right margin in the table of contents. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| lower |
Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than |
| range | Gets the portion of a document that is this table of contents. |
| tab |
Specifies the character between entries and their page numbers in the table of contents. |
| table |
Specifies a one-letter identifier from TC fields that's used for the table of contents. |
| upper |
Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than |
Methods
| delete() | Deletes this table of contents. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
| update |
Updates the entire table of contents. |
Property Details
additionalHeadingStyles
Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection.
readonly additionalHeadingStyles: Word.HeadingStyleCollection;Property Value
Remarks
areBuiltInHeadingStylesUsed
Specifies whether built-in heading styles are used for the table of contents.
areBuiltInHeadingStylesUsed: boolean;Property Value
boolean
Remarks
areFieldsUsed
Specifies whether Table of Contents Entry (TC) fields are included in the table of contents.
areFieldsUsed: boolean;Property Value
boolean
Remarks
areHyperlinksUsedOnWeb
Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web.
areHyperlinksUsedOnWeb: boolean;Property Value
boolean
Remarks
arePageNumbersHiddenOnWeb
Specifies whether the page numbers in the table of contents should be hidden when publishing to the web.
arePageNumbersHiddenOnWeb: boolean;Property Value
boolean
Remarks
arePageNumbersIncluded
Specifies whether page numbers are included in the table of contents.
arePageNumbersIncluded: boolean;Property Value
boolean
Remarks
arePageNumbersRightAligned
Specifies whether page numbers are aligned with the right margin in the table of contents.
arePageNumbersRightAligned: boolean;Property Value
boolean
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
lowerHeadingLevel
Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than upperHeadingLevel.
lowerHeadingLevel: number;Property Value
number
Remarks
range
Gets the portion of a document that is this table of contents.
readonly range: Word.Range;Property Value
Remarks
tabLeader
Specifies the character between entries and their page numbers in the table of contents.
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";Property Value
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Remarks
tableId
Specifies a one-letter identifier from TC fields that's used for the table of contents.
tableId: string;Property Value
string
Remarks
upperHeadingLevel
Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than lowerHeadingLevel.
upperHeadingLevel: number;Property Value
number
Remarks
Method Details
delete()
Deletes this table of contents.
delete(): void;Returns
void
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.TableOfContents;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableOfContents;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Word.Interfaces.TableOfContentsUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Word.TableOfContents): void;Parameters
- properties
- Word.TableOfContents
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.TableOfContents object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.TableOfContentsData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.TableOfContentsData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.TableOfContents;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.TableOfContents;Returns
updatePageNumbers()
Updates the entire table of contents.
updatePageNumbers(): void;Returns
void