Edit

Share via

Word.Interfaces.CustomXmlNodeData interface

Package:
word

An interface describing the data returned by calling customXmlNode.toJSON().

Properties

attributes

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

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

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

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

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

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

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

Gets the type of the current node.
nodeValue

Specifies the value of the current node.
ownerPart

Gets the object representing the part associated with this node.
parentNode

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

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

Specifies the text for the current node.
xml

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

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.

Property Details

attributes

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

attributes?: Word.Interfaces.CustomXmlNodeData[];

Property Value

Word.Interfaces.CustomXmlNodeData[]

Remarks

[ API set: WordApiDesktop 1.3 ]

baseName

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

baseName?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

childNodes

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

childNodes?: Word.Interfaces.CustomXmlNodeData[];

Property Value

Word.Interfaces.CustomXmlNodeData[]

Remarks

[ API set: WordApiDesktop 1.3 ]

firstChild

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.

firstChild?: Word.Interfaces.CustomXmlNodeData;

Property Value

Word.Interfaces.CustomXmlNodeData

Remarks

[ API set: WordApiDesktop 1.3 ]

lastChild

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.

lastChild?: Word.Interfaces.CustomXmlNodeData;

Property Value

Word.Interfaces.CustomXmlNodeData

Remarks

[ API set: WordApiDesktop 1.3 ]

namespaceUri

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

namespaceUri?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

nextSibling

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.

nextSibling?: Word.Interfaces.CustomXmlNodeData;

Property Value

Word.Interfaces.CustomXmlNodeData

Remarks

[ API set: WordApiDesktop 1.3 ]

nodeType

Gets the type of the current node.

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

Property Value

Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"

Remarks

[ API set: WordApiDesktop 1.3 ]

nodeValue

Specifies the value of the current node.

nodeValue?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

ownerPart

Gets the object representing the part associated with this node.

ownerPart?: Word.Interfaces.CustomXmlPartData;

Property Value

Word.Interfaces.CustomXmlPartData

Remarks

[ API set: WordApiDesktop 1.3 ]

parentNode

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

parentNode?: Word.Interfaces.CustomXmlNodeData;

Property Value

Word.Interfaces.CustomXmlNodeData

Remarks

[ API set: WordApiDesktop 1.3 ]

previousSibling

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.

previousSibling?: Word.Interfaces.CustomXmlNodeData;

Property Value

Word.Interfaces.CustomXmlNodeData

Remarks

[ API set: WordApiDesktop 1.3 ]

text

Specifies the text for the current node.

text?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

xml

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

xml?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]

xpath

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.

xpath?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.3 ]