Word.TableOfFiguresAddOptions interface
Specifies the options for adding to a Word.TableOfFiguresCollection object.
Remarks
Properties
| added |
If provided, specifies the string names of additional styles to use for the table of figures. |
| caption |
If provided, specifies the label that identifies the items to include in a table of figures. Corresponds to the |
| hide |
If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web. The default value is |
| include |
If provided, specifies whether to include the caption label and caption number in a table of figures. The default value is |
| include |
If provided, specifies whether page numbers are included in a table of figures. The default value is |
| lower |
If provided, specifies the ending heading level for a table of figures when |
| right |
If provided, specifies whether to align page numbers with the right margin in a table of figures. The default value is |
| table |
If provided, specifies a one-letter identifier from TC fields that's used for a table of figures. Corresponds to the |
| upper |
If provided, specifies the starting heading level for a table of figures when |
| use |
If provided, specifies whether to use built-in heading styles to create a table of figures. The default value is |
| use |
If provided, specifies whether to use Table of Contents Entry (TC) fields to create a table of figures. Use the TableOfFiguresCollection.markTocEntry method to mark entries to include in a table of figures. The default value is |
| use |
If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web. The default value is |
Property Details
addedStyles
If provided, specifies the string names of additional styles to use for the table of figures.
addedStyles?: string;
Property Value
string
Remarks
captionLabel
If provided, specifies the label that identifies the items to include in a table of figures. Corresponds to the \c switch for a Table of Contents (TOC) field. The default value is "Figure".
captionLabel?: string;
Property Value
string
Remarks
hidePageNumbersOnWeb
If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web. The default value is true.
hidePageNumbersOnWeb?: boolean;
Property Value
boolean
Remarks
includeLabel
If provided, specifies whether to include the caption label and caption number in a table of figures. The default value is true.
includeLabel?: boolean;
Property Value
boolean
Remarks
includePageNumbers
If provided, specifies whether page numbers are included in a table of figures. The default value is true.
includePageNumbers?: boolean;
Property Value
boolean
Remarks
lowerHeadingLevel
If provided, specifies the ending heading level for a table of figures when useBuiltInHeadingStyles is set to true. Should be a value from 1 to 9 and greater than upperHeadingLevel. Corresponds to the ending value used with the \o switch for a Table of Contents (TOC) field. The default value is 9.
lowerHeadingLevel?: number;
Property Value
number
Remarks
rightAlignPageNumbers
If provided, specifies whether to align page numbers with the right margin in a table of figures. The default value is true.
rightAlignPageNumbers?: boolean;
Property Value
boolean
Remarks
tableId
If provided, specifies a one-letter identifier from TC fields that's used for a table of figures. Corresponds to the \f switch for a Table of Contents (TOC) field. For example, "T" indicates a table of figures includes TC fields that use the table identifier T.
tableId?: string;
Property Value
string
Remarks
upperHeadingLevel
If provided, specifies the starting heading level for a table of figures when useBuiltInHeadingStyles is set to true. Should be a value from 1 to 9 and smaller than lowerHeadingLevel. Corresponds to the starting value used with the \o switch for a Table of Contents (TOC) field. The default value is 1.
upperHeadingLevel?: number;
Property Value
number
Remarks
useBuiltInHeadingStyles
If provided, specifies whether to use built-in heading styles to create a table of figures. The default value is false.
useBuiltInHeadingStyles?: boolean;
Property Value
boolean
Remarks
useFields
If provided, specifies whether to use Table of Contents Entry (TC) fields to create a table of figures. Use the TableOfFiguresCollection.markTocEntry method to mark entries to include in a table of figures. The default value is false.
useFields?: boolean;
Property Value
boolean
Remarks
useHyperlinksOnWeb
If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web. The default value is true.
useHyperlinksOnWeb?: boolean;
Property Value
boolean