Docs API Reference

CustomXmlPart.builtIn property

Get a value that indicates whether the CustomXMLPart is built-in.

Hosts: Word
Available in Requirement set CustomXmlParts
Last changed in 1.1
var isBuiltIn = customXmlPart.builtIn;

Return Value

true, if the custom XML part is built in; otherwise false.

Example

function showXMLPartBuiltIn() {
    Office.context.document.customXmlParts.getByIdAsync("{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        var xmlPart = result.value;
        write(xmlPart.builtIn);
    });
}

// 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 property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.

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