Docs API Reference

CustomXmlPart object

Represents a single CustomXMLPart in a CustomXMLParts collection.

Hosts: Word
Available in Requirement set CustomXmlParts
Last changed in 1.1



Name Description
builtIn Get a value that indicates whether the CustomXMLPart is built-in.
id Gets the GUID of the CustomXMLPart
namespaceManager Gets the set of namespace prefix mappings (CustomXMLPrefixMappings) used against the current CustomXMLPart.


Name Description
addHandlerAsync Asynchronously adds an event handler for a CustomXmlPart object event.
deleteAsync Asynchronously deletes this custom XML part from the collection.
getNodesAsync Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath.
getXmlAsync Asynchronously gets the XML inside this custom XML part.
removeHandlerAsync Removes an event handler for a CustomXmlPart object event.


Name Description
dataNodeDeleted Occurs when a node is deleted.
dataNodeInserted Occurs when a node is inserted.
dataNodeReplaced Occurs when a node is replaced.

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