Edit

Share via


Word.IndexMarkAllEntriesOptions interface

Represents options for marking all index entries in a Word document.

Remarks

[ API set: WordApiDesktop 1.4 ]

Properties

bold

If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is false.

bookmarkName

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

crossReference

If provided, specifies the cross-reference that will appear in the index. The default value is "".

crossReferenceAutoText

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

entry

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.

entryAutoText

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.

italic

If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is false.

Property Details

bold

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

[ API set: WordApiDesktop 1.4 ]

bookmarkName

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

[ API set: WordApiDesktop 1.4 ]

crossReference

If provided, specifies the cross-reference that will appear in the index. The default value is "".

crossReference?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

crossReferenceAutoText

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

[ API set: WordApiDesktop 1.4 ]

entry

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

[ API set: WordApiDesktop 1.4 ]

entryAutoText

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

[ API set: WordApiDesktop 1.4 ]

italic

If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is false.

italic?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]