Document.customXmlParts property (JavaScript API for Office)

Office Add-ins

Gets an object that represents the custom XML parts in the document.

Last modified: June 22, 2015

Note Note

The name "apps for Office" is changing to "Office Add-ins". During the transition, the documentation and the UI of some Office host applications and Visual Studio tools might still use the term "apps for Office". For details, see New name for apps for Office and SharePoint.

Hosts:

Word

Added in

1.1

See all support details

var xmlParts = Office.context.document.customXmlParts;

function getCustomXmlParts(){
    Office.context.document.customXmlParts.getByNamespaceAsync('http://tempuri.org', function (asyncResult) {
        write('Retrieved ' + asyncResult.value.length + ' custom XML parts');
    });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

A checkmark (√) 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 apps for Office.

Supported hosts, by platform

Office for Windows desktop

Office Online
(in browser)

Office for iPad

Word

Minimum permission level

Restricted

App types

Task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Added support for Word on Office for iPad.

1.0

Introduced

Show:
© 2015 Microsoft