Word.Interfaces.TableOfContentsUpdateData interface
An interface for updating data on the TableOfContents object, for use in tableOfContents.set({ ... }).
Properties
| 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. |
| lower |
Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than |
| 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 |
Property Details
areBuiltInHeadingStylesUsed
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies whether built-in heading styles are used for the table of contents.
areBuiltInHeadingStylesUsed?: boolean;Property Value
boolean
Remarks
areFieldsUsed
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies whether Table of Contents Entry (TC) fields are included in the table of contents.
areFieldsUsed?: boolean;Property Value
boolean
Remarks
areHyperlinksUsedOnWeb
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies whether page numbers are included in the table of contents.
arePageNumbersIncluded?: boolean;Property Value
boolean
Remarks
arePageNumbersRightAligned
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies whether page numbers are aligned with the right margin in the table of contents.
arePageNumbersRightAligned?: boolean;Property Value
boolean
Remarks
lowerHeadingLevel
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
tabLeader
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies a one-letter identifier from TC fields that's used for the table of contents.
tableId?: string;Property Value
string
Remarks
upperHeadingLevel
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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