Word.IndexMarkAllEntriesOptions 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.
Represents options for marking all index entries in a Word document.
Remarks
Properties
| bold | If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is |
| bookmark |
If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the |
| cross |
If provided, specifies the cross-reference that will appear in the index. The default value is "". |
| cross |
If provided, specifies the name of the |
| entry | If provided, specifies the text you want to appear in the index, in the form |
| entry |
If provided, specifies the |
| italic | If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is |
Property Details
bold
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 add bold formatting to page numbers for index entries. The default value is false.
bold?: boolean;Property Value
boolean
Remarks
bookmarkName
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 bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the XE field appears in the index. The default value is "".
bookmarkName?: string;Property Value
string
Remarks
crossReference
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 cross-reference that will appear in the index. The default value is "".
crossReference?: string;Property Value
string
Remarks
crossReferenceAutoText
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 name of the AutoText entry that contains the text for a cross-reference (if this property is specified, crossReference is ignored). The default value is "".
crossReferenceAutoText?: string;Property Value
string
Remarks
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 you want to appear in the index, in the form MainEntry[:Subentry]. The default value is "". Either this property or entryAutoText must be provided.
entry?: string;Property Value
string
Remarks
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 that contains the text you want to appear in the index (if this property is specified, entry is ignored). The default value is "". Either this property or entry must be provided.
entryAutoText?: string;Property Value
string
Remarks
italic
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 add italic formatting to page numbers for index entries. The default value is false.
italic?: boolean;Property Value
boolean