Word.IndexCollection class
A collection of Word.Index objects that represents all the indexes in the document.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(range, index |
Returns an |
| get |
Gets the |
| get |
Gets an |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| mark |
Inserts an XE (Index Entry) field after all instances of the text in the range. |
| toJSON() | Overrides the JavaScript |
| track() | 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 |
| untrack() | 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 |
Property Details
context
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
items
Gets the loaded child items in this collection.
readonly items: Word.Index[];Property Value
Method Details
add(range, indexAddOptions)
Returns an Index object that represents a new index added to the document.
add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index;Parameters
- range
- Word.Range
The range where you want the index to appear. The index replaces the range, if the range is not collapsed.
- indexAddOptions
- Word.IndexAddOptions
Optional. The options for adding the index.
Returns
Remarks
getFormat()
Gets the IndexFormat value that represents the formatting for the indexes in the document.
getFormat(): OfficeExtension.ClientResult<Word.IndexFormat>;Returns
Remarks
getItem(index)
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 an Index object by its index in the collection.
getItem(index: number): Word.Index;Parameters
- index
-
number
The location of an Index object.
Returns
Remarks
load(options)
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
Provides options for which properties of the object to load.
Returns
load(propertyNames)
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
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
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
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
markAllEntries(range, markAllEntriesOptions)
Inserts an XE (Index Entry) field after all instances of the text in the range.
markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): void;Parameters
- range
- Word.Range
The range whose text is marked with an XE field throughout the document.
- markAllEntriesOptions
- Word.IndexMarkAllEntriesOptions
Optional. The options for marking all entries.
Returns
void
Remarks
toJSON()
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()
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
untrack()
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;