Word.Interfaces.CustomXmlNodeCollectionLoadOptions interface
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Contains a collection of Word.CustomXmlNode objects representing the XML nodes in a document.
Remarks
Properties
$all | Specifying |
base |
For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. |
first |
For EACH ITEM in the collection: Gets a |
last |
For EACH ITEM in the collection: Gets a |
namespace |
For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. |
next |
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 |
node |
For EACH ITEM in the collection: Gets the type of the current node. |
node |
For EACH ITEM in the collection: Specifies the value of the current node. |
owner |
For EACH ITEM in the collection: Gets the object representing the part associated with this node. |
parent |
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 |
previous |
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 |
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
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
firstChild
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
Remarks
lastChild
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
Remarks
namespaceUri
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node.
namespaceUri?: boolean;
Property Value
boolean
Remarks
nextSibling
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
Remarks
nodeType
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Gets the type of the current node.
nodeType?: boolean;
Property Value
boolean
Remarks
nodeValue
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Specifies the value of the current node.
nodeValue?: boolean;
Property Value
boolean
Remarks
ownerPart
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Gets the object representing the part associated with this node.
ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions;
Property Value
Remarks
parentNode
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
Remarks
previousSibling
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
Remarks
text
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Specifies the text for the current node.
text?: boolean;
Property Value
boolean
Remarks
xml
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Gets the XML representation of the current node and its children.
xml?: boolean;
Property Value
boolean
Remarks
xpath
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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