Edit

Share via


Word.TableOfContentsMarkEntryOptions 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 inserting a Table of Contents Entry (TC) field.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

entry

If provided, specifies the text that appears in a table of contents or table of figures. To indicate a subentry, include the main entry text and the subentry text, separated by a colon (":") (e.g., "Introduction:The Product"). When the entryAutoText property is set, this property is ignored.

entryAutoText

If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents. When this property is used, the entry property is ignored.

level

If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9.

tableId

If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration").

Property Details

entry

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 text that appears in a table of contents or table of figures. To indicate a subentry, include the main entry text and the subentry text, separated by a colon (":") (e.g., "Introduction:The Product"). When the entryAutoText property is set, this property is ignored.

entry?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

entryAutoText

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 AutoText entry name that includes text for the table of figures, or table of contents. When this property is used, the entry property is ignored.

entryAutoText?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

level

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 level for the entry in a table of contents or table of figures and should be a value from 1 to 9.

level?: number;

Property Value

number

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 for a table of contents or table of figures (e.g., "i" for an "illustration").

tableId?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]