Word.Interfaces.XmlNodeLoadOptions interface
Represents a single XML node applied to the document.
Remarks
Properties
| $all | Specifying |
| base |
Gets the name of the element without any prefix. |
| first |
Gets the first child node if this is a parent node. Returns |
| has |
Gets whether this XML node has child nodes. Always returns |
| last |
Gets the last child node if this is a parent node. Returns |
| level | Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns |
| namespace |
Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. |
| next |
Gets the next element in the document that's at the same level as this XML node. Returns |
| owner |
Gets the parent document of this XML node. |
| parent |
Gets the parent element of this XML node. |
| placeholder |
Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. |
| previous |
Gets the previous element in the document that's at the same level as this XML node. Returns |
| range | Gets the portion of a document that is contained in this XML node. Returns |
| text | Specifies the text contained within the XML element. Returns an empty string if the node type is |
| type | Gets the type of node. |
| validation |
Gets the description for a validation error on this |
| validation |
Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. |
| value | Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. |
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
Gets the name of the element without any prefix.
baseName?: boolean;Property Value
boolean
Remarks
firstChild
Gets the first child node if this is a parent node. Returns null if the node type is attribute.
firstChild?: Word.Interfaces.XmlNodeLoadOptions;Property Value
Remarks
hasChildNodes
Gets whether this XML node has child nodes. Always returns false for attribute nodes since they cannot have children.
hasChildNodes?: boolean;Property Value
boolean
Remarks
lastChild
Gets the last child node if this is a parent node. Returns null if the node type is attribute.
lastChild?: Word.Interfaces.XmlNodeLoadOptions;Property Value
Remarks
level
Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns null if the node type is attribute.
level?: boolean;Property Value
boolean
Remarks
namespaceUri
Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node.
namespaceUri?: boolean;Property Value
boolean
Remarks
nextSibling
Gets the next element in the document that's at the same level as this XML node. Returns null if the node type is attribute.
nextSibling?: Word.Interfaces.XmlNodeLoadOptions;Property Value
Remarks
ownerDocument
Gets the parent document of this XML node.
ownerDocument?: Word.Interfaces.DocumentLoadOptions;Property Value
Remarks
parentNode
Gets the parent element of this XML node.
parentNode?: Word.Interfaces.XmlNodeLoadOptions;Property Value
Remarks
placeholderText
Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes.
placeholderText?: boolean;Property Value
boolean
Remarks
previousSibling
Gets the previous element in the document that's at the same level as this XML node. Returns null if the node type is attribute.
previousSibling?: Word.Interfaces.XmlNodeLoadOptions;Property Value
Remarks
range
Gets the portion of a document that is contained in this XML node. Returns null if the node type is attribute.
range?: Word.Interfaces.RangeLoadOptions;Property Value
Remarks
text
Specifies the text contained within the XML element. Returns an empty string if the node type is attribute.
text?: boolean;Property Value
boolean
Remarks
type
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.
Gets the type of node.
type?: boolean;Property Value
boolean
Remarks
validationErrorText
Gets the description for a validation error on this XmlNode object. May not be meaningful for attribute nodes.
validationErrorText?: boolean;Property Value
boolean
Remarks
validationStatus
Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes.
validationStatus?: boolean;Property Value
boolean
Remarks
value
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.
Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value.
value?: boolean;Property Value
boolean