Word.IndexCollection class

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Gets the loaded child items in this collection.

readonly items: Word.Index[];

Property Value

Returns an Index object that represents a new index added to the document.

add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the IndexFormat value that represents the formatting for the indexes in the document.

getFormat(): OfficeExtension.ClientResult<Word.IndexFormat>;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets an Index object by its index in the collection.

getItem(index: number): Word.Index;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.IndexCollection;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.IndexCollection;

Parameters

Returns

Inserts an XE (Index Entry) field after all instances of the text in the range.

markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.IndexCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.IndexCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Word.Interfaces.IndexCollectionData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.IndexCollection;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.IndexCollection;

Returns