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

JavaScript API for Office v1.1

Asynchronously adds a new custom XML part to a file.

Last modified: June 12, 2014

Office.context.document.customXmlParts.addAsync(xml [, options], callback);

xml

Type: string

The XML to add to the newly created custom XML part. 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 addAsync method, you can use the properties of the AsyncResult object to return the following information.

Property

Use to...

AsyncResult.value

Returns the newly created CustomXmlPart object.

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 addXMLPart() {
    Office.context.document.customXmlParts.addAsync('<root categoryId="1" xmlns="http://tempuri.org"><item name="Cheap Item" price="$193.95"/><item name="Expensive Item" price="$931.88"/></root>', function (result) {
        });
}

function addXMLPartandHandler() {
    Office.context.document.customXmlParts.addAsync("<testns:book xmlns:testns='http://testns.com'><testns:page number='1'>Hello</testns:page><testns:page number='2'>world!</testns:page></testns:book>", 
        function(r) { r.value.addHandlerAsync("nodeDeleted", 
            function(a) {write(a.type)
            }, 
                function(s) {write(s.status)
                }); 
        });
}

// 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