CustomXmlPrefixMappings.addNamespaceAsync method
Asynchronously adds a prefix to namespace mapping to use when querying an item.
| Hosts: | Word |
| Available in Requirement set | |
| Added in | 1.1 |
customXmlPrefixMappingsObj.addNamespaceAsync(prefix, ns [, options], callback);
Parameters
| Name | Type | Description | Support notes |
|---|---|---|---|
| prefix | string | Specifies the prefix to add to the prefix mapping list. Required. | |
| ns | string | Specifies the namespace to assign to the newly added prefix. Required. | |
| options | object | Specifies any of the following optional parameters | |
| asyncContext | array, boolean, null, number, object, string, or undefined | A user-defined item of any type that is returned in the AsyncResult object without being altered. | |
| callback | object | A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. |
Callback Value
When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter.
In the callback function passed to the addNamespaceAsync method, you can use the properties of the AsyncResult object to return the following information.
| Property | Use to... |
|---|---|
| AsyncResult.value | Always returns undefined because there is no object or data to retrieve. |
| AsyncResult.status | Determine the success or failure of the operation. |
| AsyncResult.error | Access an Error object that provides error information if the operation failed. |
| AsyncResult.asyncContext | Access your user-defined object or value, if you passed one as the asyncContext parameter. |
Remarks
If the prefix already exists in the namespace manager, this method will overwrite the mapping of that prefix except when the prefix is one added or used by the data store internally, in which case it will return an error.
Support details
A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.
For more information about Office host application and server requirements, see Requirements for running Office Add-ins.
| Office for Windows desktop | Office Online (in browser) | Office for iPad | |
|---|---|---|---|
| Word | Y | Y | Y |
| Available in requirement sets | CustomXmlParts |
| Minimum permission level | ReadWriteDocument |
| Add-in types | Task pane |
| Library | Office.js |
| Namespace | Office |
Support history
| Version | Changes |
|---|---|
| 1.1 | Added support for Word in Office for iPad. |
| 1.0 | Introduced |