Export (0) Print
Expand All

CustomXmlParts.getByIdAsync method (JavaScript API for Office v1.0)

JavaScript API for Office v1.0

Asynchronously gets a custom XML part by its ID.

Last modified: June 12, 2014

Office.context.document.customXmlParts.getByIdAsync(id [, options], callback);

id

Type: string

The GUID of the custom XML part, including opening and closing braces. Required.

options

Type:object

Specifies the following optional parameters.

asyncContext

Type: 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. Optional.

callback

Type: object

A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional.

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 getByIdAsync method, you can use the properties of the AsyncResult object to return the following information.

Property

Use to...

AsyncResult.value

Access a CustomXmlPart object that represents the specified custom XML part.

If there is no custom XML part with the specified id, the method returns null.

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.

Important note Important

When you specify the id parameter, you must include opening and closing braces around the GUID of the custom XML part. Failure to do so will raise a JavaScript error.

function showXMLPartInnerXML() {
    Office.context.document.customXmlParts.getByIdAsync("{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        var xmlPart = result.value;
        xmlPart.getXmlAsync({}, function (eventArgs) {
            write(eventArgs.value);
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Supported clients

Word 2013, Word 2013 RT

Library

Office.js

Namespace

Office

Show:
© 2014 Microsoft