Word.CustomXmlPrefixMappingCollection class
Represents a collection of Word.CustomXmlPrefixMapping objects.
- 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 |
Adds a custom namespace/prefix mapping to use when querying an item. |
| get |
Returns the number of items in the collection. |
| get |
Returns a |
| 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 |
| lookup |
Gets the namespace corresponding to the specified prefix. |
| lookup |
Gets the prefix corresponding to the specified namespace. |
| 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.CustomXmlPrefixMapping[];Property Value
Method Details
addNamespace(prefix, namespaceUri)
Adds a custom namespace/prefix mapping to use when querying an item.
addNamespace(prefix: string, namespaceUri: string): OfficeExtension.ClientResult<number>;Parameters
- prefix
-
string
The prefix to associate with the namespace.
- namespaceUri
-
string
The namespace URI to map.
Returns
OfficeExtension.ClientResult<number>
Remarks
getCount()
Returns the number of items in the collection.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
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.
Returns a CustomXmlPrefixMapping object that represents the specified item in the collection.
getItem(index: number): Word.CustomXmlPrefixMapping;Parameters
- index
-
number
The location of a CustomXmlPrefixMapping 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.CustomXmlPrefixMappingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPrefixMappingCollection;Parameters
- options
-
Word.Interfaces.CustomXmlPrefixMappingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions
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.CustomXmlPrefixMappingCollection;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.CustomXmlPrefixMappingCollection;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
lookupNamespace(prefix)
Gets the namespace corresponding to the specified prefix.
lookupNamespace(prefix: string): OfficeExtension.ClientResult<string>;Parameters
- prefix
-
string
The prefix to look up.
Returns
OfficeExtension.ClientResult<string>
Remarks
lookupPrefix(namespaceUri)
Gets the prefix corresponding to the specified namespace.
lookupPrefix(namespaceUri: string): OfficeExtension.ClientResult<string>;Parameters
- namespaceUri
-
string
The namespace URI to look up.
Returns
OfficeExtension.ClientResult<string>
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.CustomXmlPrefixMappingCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.CustomXmlPrefixMappingCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Word.Interfaces.CustomXmlPrefixMappingCollectionData;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.CustomXmlPrefixMappingCollection;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.CustomXmlPrefixMappingCollection;