This topic has not yet been rated - Rate this topic

CustomXmlPart.getNodesAsync method (apps for Office)

apps for SharePoint

Published: February 26, 2013

Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath.

customXmlPart.getNodesAsync(xPath [, options], callback);
xPath

Type: string

An XPath expression that specifies the nodes you want returned. 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: 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.

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. Use the AsyncResult.value property to access to an array of CustomXMLNode objects that represent the nodes specified by XPath expression passed to the xPath parameter. To determine the success or failure of the operation, use the AsyncResult.status property. If the operation failed, use the AsyncResult.error property to access an Error object that provides information about the error. If you passed a user-defined object to the asyncContext parameter, use the AsyncResult.asyncContext property to access that object.

function showXmlNodeType() {
    Office.context.document.customXmlParts.getByIdAsync("{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        var xmlPart = result.value;
        xmlPart.getNodesAsync('*/*', function (nodeResults) {
            for (i = 0; i < nodeResults.value.length; i++) {
                var node = nodeResults.value[i];
                write(node.nodeType);
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Supported clients

Word 2013

Library

Office.js

Namespace

Office

Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.