Edit

Share via


Word.TableOfFiguresAddOptions interface

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 options for adding to a Word.TableOfFiguresCollection object.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

addedStyles

If provided, specifies the string names of additional styles to use for the table of figures.

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".

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.

includeLabel

If provided, specifies whether to include the caption label and caption number in a table of figures. The default value is true.

includePageNumbers

If provided, specifies whether page numbers are included in a table of figures. The default value is true.

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.

rightAlignPageNumbers

If provided, specifies whether to align page numbers with the right margin in a table of figures. The default value is true.

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.

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.

useBuiltInHeadingStyles

If provided, specifies whether to use built-in heading styles to create a table of figures. The default value is false.

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.

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.

Property Details

addedStyles

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.

If provided, specifies the string names of additional styles to use for the table of figures.

addedStyles?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

captionLabel

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.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

hidePageNumbersOnWeb

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.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

includeLabel

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.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

includePageNumbers

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.

If provided, specifies whether page numbers are included in a table of figures. The default value is true.

includePageNumbers?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

rightAlignPageNumbers

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.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

useBuiltInHeadingStyles

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.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

useFields

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.

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

useHyperlinksOnWeb

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.

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]