CustomXmlParts.getByIdAsync method

Asynchronously gets a custom XML part by its ID.

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

Parameters

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

Remarks

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.

Example

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; 
}

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.

Support history