Word.Interfaces.XmlNodeCollectionLoadOptions interface

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

For EACH ITEM in the collection: Gets the name of the element without any prefix.

baseName?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets whether this XML node has child nodes. Always returns false for attribute nodes since they cannot have children.

hasChildNodes?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node.

namespaceUri?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

nodeType?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value.

nodeValue?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets the parent document of this XML node.

ownerDocument?: Word.Interfaces.DocumentLoadOptions;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets the parent element of this XML node.

parentNode?: Word.Interfaces.XmlNodeLoadOptions;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes.

placeholderText?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Specifies the text contained within the XML element. Returns an empty string if the node type is attribute.

text?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets the description for a validation error on this XmlNode object. May not be meaningful for attribute nodes.

validationErrorText?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

For EACH ITEM in the collection: Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes.

validationStatus?: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]