Edit

Share via

Word.Interfaces.CustomXmlPartLoadOptions interface

Package:
word

Represents a custom XML part.

Remarks

[ API set: WordApi 1.4 ]

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).
builtIn

Gets a value that indicates whether the CustomXmlPart is built-in.
documentElement

Gets the root element of a bound region of data in the document. If the region is empty, the property returns Nothing.
id

Gets the ID of the custom XML part.
namespaceUri

Gets the namespace URI of the custom XML part.
xml

Gets the XML representation of the current CustomXmlPart object.

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

builtIn

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 a value that indicates whether the CustomXmlPart is built-in.

builtIn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

documentElement

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 root element of a bound region of data in the document. If the region is empty, the property returns Nothing.

documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions;

Property Value

Word.Interfaces.CustomXmlNodeLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

id

Gets the ID of the custom XML part.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

namespaceUri

Gets the namespace URI of the custom XML part.

namespaceUri?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

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.

Gets the XML representation of the current CustomXmlPart object.

xml?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]