Docs API Reference

CustomXmlParts.getByIdAsync method

Asynchronously gets a custom XML part by its ID.

Hosts: Word
Available in Requirement set CustomXmlParts
Added in 1.1
Office.context.document.customXmlParts.getByIdAsync(id [, options], callback);


Name Type Description Support notes
id string The GUID of the custom XML part, including opening and closing braces. Required.
options object Specifies any of the following optional parameters
asyncContext 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.
callback object A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.

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.

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: 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) {
// 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.

Office for Windows desktop Office Online (in browser) Office for iPad
Word Y Y
Available in requirement sets CustomXmlParts
Minimum permission level ReadWriteDocument
Add-in types Task pane
Library Office.js
Namespace Office

Support history

Version Changes
1.1 Added support for Word in Office for iPad.
1.0 Introduced