Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Word.Interfaces.TableOfFiguresUpdateData interface
- Package:
- word
An interface for updating data on the TableOfFigures object, for use in tableOfFigures.set({ ... }).
Properties
| areBuiltInHeadingStylesUsed | Specifies whether built-in heading styles are used for the table of figures. |
| areFieldsUsed | Specifies whether Table of Contents Entry (TC) fields are included in the table of figures. |
| areHyperlinksUsedOnWeb | Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. |
| arePageNumbersHiddenOnWeb | Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. |
| arePageNumbersIncluded | Specifies whether page numbers are included in the table of figures. |
| arePageNumbersRightAligned | Specifies whether page numbers are aligned with the right margin in the table of figures. |
| captionLabel | Specifies the label that identifies the items to be included in the table of figures. |
| isLabelIncluded | Specifies whether the caption label and caption number are included in the table of figures. |
| lowerHeadingLevel | Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than |
| tabLeader | Specifies the character between entries and their page numbers in the table of figures. |
| tableId | Specifies a one-letter identifier from TC fields that's used for the table of figures. |
| upperHeadingLevel | Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than |
Property Details
areBuiltInHeadingStylesUsed
Specifies whether built-in heading styles are used for the table of figures.
areBuiltInHeadingStylesUsed?: boolean;Property Value
boolean
Remarks
areFieldsUsed
Specifies whether Table of Contents Entry (TC) fields are included in the table of figures.
areFieldsUsed?: boolean;Property Value
boolean
Remarks
areHyperlinksUsedOnWeb
Specifies whether entries in the table of figures 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 figures 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 figures.
arePageNumbersIncluded?: boolean;Property Value
boolean
Remarks
arePageNumbersRightAligned
Specifies whether page numbers are aligned with the right margin in the table of figures.
arePageNumbersRightAligned?: boolean;Property Value
boolean
Remarks
captionLabel
Specifies the label that identifies the items to be included in the table of figures.
captionLabel?: string;Property Value
string
Remarks
isLabelIncluded
Specifies whether the caption label and caption number are included in the table of figures.
isLabelIncluded?: boolean;Property Value
boolean
Remarks
lowerHeadingLevel
Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than upperHeadingLevel.
lowerHeadingLevel?: number;Property Value
number
Remarks
tabLeader
Specifies the character between entries and their page numbers in the table of figures.
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 figures.
tableId?: string;Property Value
string
Remarks
upperHeadingLevel
Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than lowerHeadingLevel.
upperHeadingLevel?: number;Property Value
number
Remarks
Office Add-ins
Feedback
Was this page helpful?