Skip to content

API reference / Common / Engine types / CustomXml

Interface: CustomXml ​

What a custom XML element is (w:customXml's uri / element plus w:customXmlPr), minus what it wraps.

Level-independent, as the schema's is: CT_CustomXmlBlock, CT_CustomXmlRun, CT_CustomXmlRow and CT_CustomXmlCell differ only in the content they admit, and each carries this same trio. So the level is said by the node holding this — TextCustomXmlBlock, TextCustomXmlSpan, TableCustomXmlRow or TableCustomXmlCell — and never restated here, where the two could disagree.

Unlike a ContentControl, it declares nothing about behavior: no kind, no lock, no data binding. It is a name from someone else's schema draped over a range, which is why the whole of it is three fields.

Placeholder — the type is here and the levels hold it, but nothing imports, exports or edits one yet.

Properties ​

PropertyDescription
id
string
Stable model id — what the mark carrying this element's extent names.
element
string
w:element — the element's name. Required by the schema.
uri?
string
w:uri — the namespace it belongs to, absent for an unqualified element.
placeholder?
string
w:customXmlPr/w:placeholder — the placeholder text shown while the wrapped range is empty. The one field a SmartTag has no counterpart for.
attributes?
XmlAttribute[]
w:customXmlPr/w:attr — the element's attributes, in document order.