Edit

Share via

Word.Interfaces.CustomXmlNodeCollectionLoadOptions interface

Package:
word

Contains a collection of Word.CustomXmlNode objects representing the XML nodes in a document.

Remarks

[ API set: WordApiDesktop 1.3 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
baseName

For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists.
firstChild

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node.
nextSibling

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Gets the type of the current node.
nodeValue

For EACH ITEM in the collection: Specifies the value of the current node.
ownerPart

For EACH ITEM in the collection: Gets the object representing the part associated with this node.
parentNode

For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns Nothing.
previousSibling

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the text for the current node.
xml

For EACH ITEM in the collection: Gets the XML representation of the current node and its children.
xpath

For EACH ITEM in the collection: 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

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

baseName

For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists.

baseName?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

firstChild

For EACH ITEM in the collection: 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.CustomXmlNodeLoadOptions;

Property Value

Word.Interfaces.CustomXmlNodeLoadOptions

Remarks

[ API set: WordApiDesktop 1.3 ]

lastChild

For EACH ITEM in the collection: 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.CustomXmlNodeLoadOptions;

Property Value

Word.Interfaces.CustomXmlNodeLoadOptions

Remarks

[ API set: WordApiDesktop 1.3 ]

namespaceUri

For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node.

namespaceUri?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

nextSibling

For EACH ITEM in the collection: 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.CustomXmlNodeLoadOptions;

Property Value

Word.Interfaces.CustomXmlNodeLoadOptions

Remarks

[ API set: WordApiDesktop 1.3 ]

nodeType

For EACH ITEM in the collection: Gets the type of the current node.

nodeType?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

nodeValue

For EACH ITEM in the collection: Specifies the value of the current node.

nodeValue?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

ownerPart

For EACH ITEM in the collection: Gets the object representing the part associated with this node.

ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions;

Property Value

Word.Interfaces.CustomXmlPartLoadOptions

Remarks

[ API set: WordApiDesktop 1.3 ]

parentNode

For EACH ITEM in the collection: 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.CustomXmlNodeLoadOptions;

Property Value

Word.Interfaces.CustomXmlNodeLoadOptions

Remarks

[ API set: WordApiDesktop 1.3 ]

previousSibling

For EACH ITEM in the collection: 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.CustomXmlNodeLoadOptions;

Property Value

Word.Interfaces.CustomXmlNodeLoadOptions

Remarks

[ API set: WordApiDesktop 1.3 ]

text

For EACH ITEM in the collection: Specifies the text for the current node.

text?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

xml

For EACH ITEM in the collection: Gets the XML representation of the current node and its children.

xml?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

xpath

For EACH ITEM in the collection: 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?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]