Word.Interfaces.TableOfFiguresCollectionLoadOptions interface

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of figures.

areBuiltInHeadingStylesUsed?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies whether Table of Contents Entry (TC) fields are included in the table of figures.

areFieldsUsed?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web.

areHyperlinksUsedOnWeb?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies whether the page numbers in the table of figures should be hidden when publishing to the web.

arePageNumbersHiddenOnWeb?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies whether page numbers are included in the table of figures.

arePageNumbersIncluded?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies whether page numbers are aligned with the right margin in the table of figures.

arePageNumbersRightAligned?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies the label that identifies the items to be included in the table of figures.

captionLabel?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies whether the caption label and caption number are included in the table of figures.

isLabelIncluded?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than upperHeadingLevel.

lowerHeadingLevel?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets the portion of a document that is this table of figures.

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies the character between entries and their page numbers in the table of figures.

tabLeader?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies a one-letter identifier from TC fields that's used for the table of figures.

tableId?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than lowerHeadingLevel.

upperHeadingLevel?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]