3.1.3.1.1 customXml (Ruby Inline-Level Custom XML Element)

Article
10/15/2020

This element specifies the presence of a custom XML element around one or more inline-level structures (runs, images, fields, and so on) within a paragraph. The attributes on this element shall be used to specify the name and namespace URI of the current custom XML element.

[Example: Consider a custom XML element with the name firstName that shall be located around two text runs in a WordprocessingML document. This requirement would be specified as follows in the WordprocessingML:

 <w:p>
   <w:customXml w:element="firstName" … >
     <w:r>
       …
     </w:r>
     <w:r>
       …
     </w:r>
   </w:customXml>
   …
 </w:p>

The customXml element specifies that the name of the custom XML element is firstName, and the custom XML element contains two text runs (it is an inline-level element). end example]

Parent Elements
customXml (§3.1.3.1.1, customXml); fldSimple (§3.1.3.1.2, fldSimple); hyperlink (§3.1.3.1.3, hyperlink); rt ("[ISO/IEC-29500-1] §17.3.3.24"); rubyBase ("[ISO/IEC-29500-1] §17.3.3.27"); sdtContent (§3.1.3.1.7, sdtContent)

Child Elements	Subclause
acc (Accent)	"[ISO/IEC-29500-1] §22.1.2.1"
bar (Bar)	"[ISO/IEC-29500-1] §22.1.2.7"
bookmarkEnd (Bookmark End)	"[ISO/IEC-29500-1] §17.13.6.1"
bookmarkStart (Bookmark Start)	"[ISO/IEC-29500-1] §17.13.6.2"
borderBox (Border-Box Object)	"[ISO/IEC-29500-1] §22.1.2.11"
box (Box Object)	"[ISO/IEC-29500-1] §22.1.2.13"
commentRangeEnd (Comment Anchor Range End)	"[ISO/IEC-29500-1] §17.13.4.3"
commentRangeStart (Comment Anchor Range Start)	"[ISO/IEC-29500-1] §17.13.4.4"
customXml (Ruby Inline-Level Custom XML Element)	§3.1.3.1.1, customXml
customXmlDelRangeEnd (Custom XML Markup Deletion End)	"[ISO/IEC-29500-1] §17.13.5.4"
customXmlDelRangeStart (Custom XML Markup Deletion Start)	"[ISO/IEC-29500-1] §17.13.5.5"
customXmlInsRangeEnd (Custom XML Markup Insertion End)	"[ISO/IEC-29500-1] §17.13.5.6"
customXmlInsRangeStart (Custom XML Markup Insertion Start)	"[ISO/IEC-29500-1] §17.13.5.7"
customXmlMoveFromRangeEnd (Custom XML Markup Move Source End)	"[ISO/IEC-29500-1] §17.13.5.8"
customXmlMoveFromRangeStart (Custom XML Markup Move Source Start)	"[ISO/IEC-29500-1] §17.13.5.9"
customXmlMoveToRangeEnd (Custom XML Markup Move Destination Location End)	"[ISO/IEC-29500-1] §17.13.5.10"
customXmlMoveToRangeStart (Custom XML Markup Move Destination Location Start)	"[ISO/IEC-29500-1] §17.13.5.11"
customXmlPr (Custom XML Element Properties)	"[ISO/IEC-29500-1] §17.5.1.7"
d (Delimiter Object)	"[ISO/IEC-29500-1] §22.1.2.24"
del (Deleted Run Content)	"[ISO/IEC-29500-1] §17.13.5.14"
eqArr (Array Object)	"[ISO/IEC-29500-1] §22.1.2.34"
f (Fraction Object)	"[ISO/IEC-29500-1] §22.1.2.36"
fldSimple (Ruby Simple Field)	§3.1.3.1.2, fldSimple
func (Function Apply Object)	"[ISO/IEC-29500-1] §22.1.2.39"
groupChr (Group-Character Object)	"[ISO/IEC-29500-1] §22.1.2.41"
hyperlink (Ruby Hyperlink)	§3.1.3.1.3, hyperlink
ins (Inserted Run Content)	"[ISO/IEC-29500-1] §17.13.5.18"
limLow (Lower-Limit Object)	"[ISO/IEC-29500-1] §22.1.2.54"
limUpp (Upper-Limit Object)	"[ISO/IEC-29500-1] §22.1.2.56"
m (Matrix Object)	"[ISO/IEC-29500-1] §22.1.2.60"
moveFrom (Move Source Run Content)	"[ISO/IEC-29500-1] §17.13.5.22"
moveFromRangeEnd (Move Source Location Container - End)	"[ISO/IEC-29500-1] §17.13.5.23"
moveFromRangeStart (Move Source Location Container - Start)	"[ISO/IEC-29500-1] §17.13.5.24"
moveTo (Move Destination Run Content)	"[ISO/IEC-29500-1] §17.13.5.25"
moveToRangeEnd (Move Destination Location Container - End)	"[ISO/IEC-29500-1] §17.13.5.27"
moveToRangeStart (Move Destination Location Container - Start)	"[ISO/IEC-29500-1] §17.13.5.28"
nary (n-ary Operator Object)	"[ISO/IEC-29500-1] §22.1.2.70"
oMath (Office Math)	"[ISO/IEC-29500-1] §22.1.2.77"
oMathPara (Office Math Paragraph)	"[ISO/IEC-29500-1] §22.1.2.78"
permEnd (Range Permission End)	"[ISO/IEC-29500-1] §17.13.7.1"
permStart (Range Permission Start)	"[ISO/IEC-29500-1] §17.13.7.2"
phant (Phantom Object)	"[ISO/IEC-29500-1] §22.1.2.81"
proofErr (Proofing Error Anchor)	"[ISO/IEC-29500-1] §17.13.8.1"
r (Run)	"[ISO/IEC-29500-1] §22.1.2.87"
r (Text Run)	"[ISO/IEC-29500-1] §17.3.2.25"
rad (Radical Object)	"[ISO/IEC-29500-1] §22.1.2.88"
sdt (Ruby Inline-Level Structured Document Tag)	§3.1.3.1.6, sdt
sPre (Pre-Sub-Superscript Object)	"[ISO/IEC-29500-1] §22.1.2.99"
sSub (Subscript Object)	"[ISO/IEC-29500-1] §22.1.2.101"
sSubSup (Sub-Superscript Object)	"[ISO/IEC-29500-1] §22.1.2.103"
sSup (Superscript Object)	"[ISO/IEC-29500-1] §22.1.2.105"

Attributes	Description
element (Custom XML Element)	Specifies the name of the current custom XML element or smart tag within the document. [Example: Consider a custom XML element which shall have a name of companyName. This requirement would be specified using the following WordprocessingML: <w:customXml w:element="companyName" … > … </w:customXml> The element attribute specifies that the name for this element shall be companyName. end example] The possible values for this attribute are defined by the ST_NcName255 simple type (§3.1.3.3.4, ST_NcName255).
uri (Custom XML Element Namespace)	Specifies the namespace URI of the current custom XML element or smart tag. If this attribute is omitted, the URI shall be assumed to be null (no associated URI). [Example: Consider a custom XML element which shall have a namespace URI of urn:customXmlExample. This requirement would be specified using the following WordprocessingML: <w:customXml … w:uri="urn:customXmlExample" /> … </w:customXml> The uri attribute specifies that the namespace for this element shall be urn:customXmlExample. end example] The possible values for this attribute are defined by the ST_CustomXmlURI simple type (§3.1.3.3.1, ST_CustomXmlURI).

Attributes

Description

element (Custom XML Element)

Specifies the name of the current custom XML element or smart tag within the document.

[Example: Consider a custom XML element which shall have a name of companyName. This requirement would be specified using the following WordprocessingML:

 <w:customXml   w:element="companyName" … >
     …
 </w:customXml>

The element attribute specifies that the name for this element shall be companyName. end example]

The possible values for this attribute are defined by the ST_NcName255 simple type (§3.1.3.3.4, ST_NcName255).

uri (Custom XML Element Namespace)

Specifies the namespace URI of the current custom XML element or smart tag.

If this attribute is omitted, the URI shall be assumed to be null (no associated URI).

[Example: Consider a custom XML element which shall have a namespace URI of urn:customXmlExample. This requirement would be specified using the following WordprocessingML:

 <w:customXml   … w:uri="urn:customXmlExample" />
     …
 </w:customXml>

The uri attribute specifies that the namespace for this element shall be urn:customXmlExample. end example]

The possible values for this attribute are defined by the ST_CustomXmlURI simple type (§3.1.3.3.1, ST_CustomXmlURI).

The following XML Schema fragment defines the contents of this element:

 <complexType name="CT_CustomXmlRuby">
   <sequence>
     <element name="customXmlPr" type="CT_CustomXmlPr" minOccurs="0" maxOccurs="1"/>
     <group ref="EG_RubyContent" minOccurs="0" maxOccurs="unbounded"/>
   </sequence>
   <attribute name="uri" type="ST_CustomXmlURI"/>
   <attribute name="element" type="ST_NcName255" use="required"/>
 </complexType>

3.1.3.1.1 customXml (Ruby Inline-Level Custom XML Element)

Additional resources