Edit

Share via

Word.Interfaces.IndexLoadOptions interface

Package:
word

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 a single index. The Index object is a member of the Word.IndexCollection. The IndexCollection includes all the indexes in the document.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

$all

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).
filter

Gets a value that represents how Microsoft Word classifies the first character of entries in the index. See IndexFilter for available values.
headingSeparator

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

Gets a LanguageId value that represents the sorting language to use for the index.
numberOfColumns

Gets the number of columns for each page of the index.
range

Returns a Range object that represents the portion of the document that is contained within the index.
rightAlignPageNumbers

Specifies if page numbers are aligned with the right margin in the index.
separateAccentedLetterHeadings

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).
sortBy

Specifies the sorting criteria for the index.
tabLeader

Specifies the leader character between entries in the index and their associated page numbers.
type

Gets the index type.

Property Details

$all

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.

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

boolean

filter

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.

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

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

headingSeparator

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.

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

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

indexLanguage

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.

Gets a LanguageId value that represents the sorting language to use for the index.

indexLanguage?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

numberOfColumns

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.

Gets the number of columns for each page of the index.

numberOfColumns?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

range

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.

Returns a Range object that represents the portion of the document that is contained within the index.

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Word.Interfaces.RangeLoadOptions

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.

Specifies if page numbers are aligned with the right margin in the index.

rightAlignPageNumbers?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

separateAccentedLetterHeadings

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.

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

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

sortBy

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 sorting criteria for the index.

sortBy?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

tabLeader

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 leader character between entries in the index and their associated page numbers.

tabLeader?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

type

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.

Gets the index type.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]