Word.Interfaces.IndexCollectionLoadOptions interface

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

For EACH ITEM in the collection: Gets a value that represents how Microsoft Word classifies the first character of entries in the index. See IndexFilter for available values.

filter?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to the \h switch for an INDEX field.

headingSeparator?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets a LanguageId value that represents the sorting language to use for the index.

indexLanguage?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets the number of columns for each page of the index.

numberOfColumns?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Returns a Range object that represents the portion of the document that is contained within the index.

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies if page numbers are aligned with the right margin in the index.

rightAlignPageNumbers?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under one heading and words that begin with "A" are under another).

separateAccentedLetterHeadings?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies the sorting criteria for the index.

sortBy?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies the leader character between entries in the index and their associated page numbers.

tabLeader?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets the index type.

type?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]