Word.CustomXmlNode class

Gets a CustomXmlNodeCollection object representing the attributes of the current element in the current node.

readonly attributes: Word.CustomXmlNodeCollection;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the base name of the node without the namespace prefix, if one exists.

readonly baseName: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets a CustomXmlNodeCollection object containing all of the child elements of the current node.

readonly childNodes: Word.CustomXmlNodeCollection;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Gets a CustomXmlNode object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type CustomXmlNodeType.element), returns Nothing.

readonly firstChild: Word.CustomXmlNode;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets a CustomXmlNode object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type CustomXmlNodeType.element), the property returns Nothing.

readonly lastChild: Word.CustomXmlNode;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the unique address identifier for the namespace of the node.

readonly namespaceUri: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns Nothing.

readonly nextSibling: Word.CustomXmlNode;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the type of the current node.

readonly nodeType: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the value of the current node.

nodeValue: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the object representing the part associated with this node.

readonly ownerPart: Word.CustomXmlPart;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the parent element node of the current node. If the current node is at the root level, the property returns Nothing.

readonly parentNode: Word.CustomXmlNode;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns Nothing.

readonly previousSibling: Word.CustomXmlNode;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the text for the current node.

text: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the XML representation of the current node and its children.

readonly xml: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message.

readonly xpath: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Appends a single node as the last child under the context element node in the tree.

appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions): OfficeExtension.ClientResult<number>;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Adds a subtree as the last child under the context element node in the tree.

appendChildSubtree(xml: string): OfficeExtension.ClientResult<number>;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Deletes the current node from the tree (including all of its children, if any exist).

delete(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies if the current element node has child element nodes.

hasChildNodes(): OfficeExtension.ClientResult<boolean>;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Inserts a new node just before the context node in the tree.

insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions): OfficeExtension.ClientResult<number>;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Inserts the specified subtree into the location just before the context node.

insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions): OfficeExtension.ClientResult<number>;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.CustomXmlNodeLoadOptions): Word.CustomXmlNode;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.CustomXmlNode;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.CustomXmlNode;

Parameters

Returns

Removes the specified child node from the tree.

removeChild(child: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Removes the specified child node and replaces it with a different node in the same location.

replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions): OfficeExtension.ClientResult<number>;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Removes the specified node and replaces it with a different subtree in the same location.

replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Selects a collection of nodes matching an XPath expression.

selectNodes(xPath: string): Word.CustomXmlNodeCollection;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Selects a single node from a collection matching an XPath expression.

selectSingleNode(xPath: string): Word.CustomXmlNode;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.CustomXmlNodeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.CustomXmlNode): void;

Parameters

Returns

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.CustomXmlNode object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.CustomXmlNodeData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.CustomXmlNodeData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.CustomXmlNode;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.CustomXmlNode;

Returns