Export (0) Print
Expand All

CustomXmlParts.getByNamespaceAsync method (JavaScript API for Office v1.1)

JavaScript API for Office v1.1

Asynchronously gets an array of custom XML parts that match the specified namespace.

Last modified: June 12, 2014

Office.context.document.customXmlParts.getByNamespaceAsync(ns [, options], callback);

ns

Type: string

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

Property

Use to...

AsyncResult.value

Access an array of CustomXMLPart objects that match 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.

function showXMLPartsInNamespace() {
    Office.context.document.customXmlParts.getByNamespaceAsync("http://tempuri.org", function (eventArgs) {
        write("Found " + eventArgs.value.length + " parts with this namespace");
    }); 
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

App types

Task pane apps

Supported clients

Word 2013, Word 2013 SP1, Word 2013 RT

Library

Office.js

Namespace

Office

Show:
© 2014 Microsoft