Edit

Share via

Word.Interfaces.CustomXmlPartData interface

Package:
word

An interface describing the data returned by calling customXmlPart.toJSON().

Properties

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.
errors

Gets a CustomXmlValidationErrorCollection object that provides access to any XML validation errors.
id

Gets the ID of the custom XML part.
namespaceManager

Gets the set of namespace prefix mappings used against the current CustomXmlPart object.
namespaceUri

Gets the namespace URI of the custom XML part.
schemaCollection

Specifies a CustomXmlSchemaCollection object representing the set of schemas attached to a bound region of data in the document.
xml

Gets the XML representation of the current CustomXmlPart object.

Property Details

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.CustomXmlNodeData;

Property Value

Word.Interfaces.CustomXmlNodeData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

errors

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 CustomXmlValidationErrorCollection object that provides access to any XML validation errors.

errors?: Word.Interfaces.CustomXmlValidationErrorData[];

Property Value

Word.Interfaces.CustomXmlValidationErrorData[]

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

id

Gets the ID of the custom XML part.

id?: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

namespaceManager

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 set of namespace prefix mappings used against the current CustomXmlPart object.

namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[];

Property Value

Word.Interfaces.CustomXmlPrefixMappingData[]

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

namespaceUri

Gets the namespace URI of the custom XML part.

namespaceUri?: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

schemaCollection

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 a CustomXmlSchemaCollection object representing the set of schemas attached to a bound region of data in the document.

schemaCollection?: Word.Interfaces.CustomXmlSchemaData[];

Property Value

Word.Interfaces.CustomXmlSchemaData[]

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]