CustomXmlRun class
Defines the CustomXmlRun Class. When the object is serialized out as xml, its qualified name is w:customXml.
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Wordprocessing.CustomXmlElement
DocumentFormat.OpenXml.Wordprocessing.CustomXmlRun
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
[ISO/IEC 29500-1 1st Edition]
customXml (Inline-Level Custom XML Element)
This element specifies the presence of a custom XML element around one or more inline level structures (runs, images, fields, etc.) within a paragraph. The attributes on this element shall be used to specify the name and namespace of the current custom XML element.
[Example: Consider a custom XML element with the name firstName that must be located around a 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 a two text runs (it is an inline-level element). end example]
Parent Elements |
|---|
bdo (§17.3.2.3); customXml (§17.5.1.3); del (§17.13.5.14); dir (§17.3.2.8); fldSimple (§17.16.19); hyperlink (§17.16.22); ins (§17.13.5.18); moveFrom (§17.13.5.22); moveTo (§17.13.5.25); p (§17.3.1.22); sdtContent (§17.5.2.36); smartTag (§17.5.1.9) |
Child Elements | Subclause |
|---|---|
bdo (Bidirectional Override) | §17.3.2.3 |
bookmarkEnd (Bookmark End) | §17.13.6.1 |
bookmarkStart (Bookmark Start) | §17.13.6.2 |
commentRangeEnd (Comment Anchor Range End) | §17.13.4.3 |
commentRangeStart (Comment Anchor Range Start) | §17.13.4.4 |
customXml (Inline-Level Custom XML Element) | §17.5.1.3 |
customXmlDelRangeEnd (Custom XML Markup Deletion End) | §17.13.5.4 |
customXmlDelRangeStart (Custom XML Markup Deletion Start) | §17.13.5.5 |
customXmlInsRangeEnd (Custom XML Markup Insertion End) | §17.13.5.6 |
customXmlInsRangeStart (Custom XML Markup Insertion Start) | §17.13.5.7 |
customXmlMoveFromRangeEnd (Custom XML Markup Move Source End) | §17.13.5.8 |
customXmlMoveFromRangeStart (Custom XML Markup Move Source Start) | §17.13.5.9 |
customXmlMoveToRangeEnd (Custom XML Markup Move Destination Location End) | §17.13.5.10 |
customXmlMoveToRangeStart (Custom XML Markup Move Destination Location Start) | §17.13.5.11 |
customXmlPr (Custom XML Element Properties) | §17.5.1.7 |
del (Deleted Run Content) | §17.13.5.14 |
dir (Bidirectional Embedding Level) | §17.3.2.8 |
fldSimple (Simple Field) | §17.16.19 |
hyperlink (Hyperlink) | §17.16.22 |
ins (Inserted Run Content) | §17.13.5.18 |
moveFrom (Move Source Run Content) | §17.13.5.22 |
moveFromRangeEnd (Move Source Location Container - End) | §17.13.5.23 |
moveFromRangeStart (Move Source Location Container - Start) | §17.13.5.24 |
moveTo (Move Destination Run Content) | §17.13.5.25 |
moveToRangeEnd (Move Destination Location Container - End) | §17.13.5.27 |
moveToRangeStart (Move Destination Location Container - Start) | §17.13.5.28 |
oMath (Office Math) | §22.1.2.77 |
oMathPara (Office Math Paragraph) | §22.1.2.78 |
permEnd (Range Permission End) | §17.13.7.1 |
permStart (Range Permission Start) | §17.13.7.2 |
proofErr (Proofing Error Anchor) | §17.13.8.1 |
r (Text Run) | §17.3.2.25 |
sdt (Inline-Level Structured Document Tag) | §17.5.2.31 |
smartTag (Inline-Level Smart Tag) | §17.5.1.9 |
subDoc (Anchor for Subdocument Location) | §17.17.1.1 |
Attributes | Description |
|---|---|
element (Element name) | Specifies the name of the current custom XML element or smart tag within the document. [Example: Consider a custom XML element which must 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 must be companyName. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13). |
uri (Custom XML Markup Namespace) | Specifies the namespace of the current custom XML element or smart tag. If this attribute is omitted, the shall be assumed to be null (no associated ). [Example: Consider a custom XML element which must have a namespace 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 must be urn:customXmlExample. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13). |
[Note: The W3C XML Schema definition of this element’s content model (CT_CustomXmlRun) is located in §A.1. end note]
© ISO/IEC29500: 2008.