Docs API Reference

CustomXmlPrefixMappings.getPrefixAsync method

Asynchronously gets the prefix for the specified namespace.

Hosts: Word
Available in Requirement set CustomXmlParts
Last changed in 1.1
customXmlPrefixMappingsObj.getPrefixAsync(ns [, options], callback);

Parameters

Name Type Description Support notes
ns string Specifies the namespace to get the prefix for. 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 getPrefixAsync method, you can use the properties of the AsyncResult object to return the following information.

Property Use to...
AsyncResult.value Access to a string that contains the prefix of the specified namespace.
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 no prefix is assigned to the requested namespace, the method returns an empty string (""). If there are multiple prefixes specified in the namespace manager, the method returns the first prefix that matches the supplied namespace.

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