Export (0) Print
Expand All

CustomXmlDelRangeStart class

Defines the CustomXmlDelRangeStart Class. When the object is serialized out as xml, its qualified name is w:customXmlDelRangeStart.

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

public class CustomXmlDelRangeStart : TrackChangeType

[ISO/IEC 29500-1 1st Edition]

customXmlDelRangeStart (Custom XML Markup Deletion Start)

This element specifies the beginning of a region in which all custom XML markup has been deleted and tracked as a revision. The id attribute on this element shall be used to link this element with the corresponding custom XML markup deletion end marker in the document.

Providing a physical representation of custom XML markup results in regions which can be inserted and deleted, but cannot be encapsulated by a single revision element, since their representation in WordprocessingML is the start or end XML tag for the custom XML markup which it represents. Therefore, the start/end "cross structure" annotation format surrounds the WordprocessingML region to which this deletion applies.

The following restrictions shall be applied to this element:

  • If this element occurs without a corresponding customXmlDelRangeEnd element (§17.13.5.4) with a matching id attribute value, then the document is non-conformant .

  • If this element and its paired end encapsulate a range with no custom XML markup, then the document is non-conformant .

  • If multiple start elements exist with the same id attribute value, then the document is non-conformant .

[Example: Consider a document with two inline custom XML markup elements, as follows:

<w:p>
  <w:customXml … >
    <w:customXml … >
      <w:r>
        <w:t>Text.</w:t>
      </w:r>
    </w:customXml>
  </w:customXml>
  <w:r>
    <w:t>More text.</w:t>
  </w:r>
</w:p>

Now, if each custom XML markup element's start and end tag have a physical representation, imagine that the region from the start of the paragraph until the point between the two end points is deleted with revisions enabled. This revision cannot be encapsulated by one del element, since it starts outside of the first custom XML markup element and ends just inside of it, so it must be done using the custom XML markup revision "cross structure" syntax, as follows:

<w:p>
  <w:customXmlDelRangeStart w:id="0" w:author="Jamie" />
  <w:customXml … >
    <w:customXml … >
      <w:del … >
        <w:r>
          <w:delText>Text.</w:delText>
        </w:r>
      </w:del>
    </w:customXml>
    <w:customXmlDelRangeEnd w:id="0" />
  </w:customXml>
  <w:r>
    <w:t>More text.</w:t>
  </w:r>
</w:p>

The customXmlDelRangeStart element delimits the start of the region in which all custom XML elements have been deleted with revisions enabled, and the del element (§17.13.5.14) handles the deletion of the text performed by this revision. Since the end of the outer customXml element was not in the deleted range, it is not revision marked deleted, but the corresponding physical character for the start element is. end example]

Parent Elements

bdo (§17.3.2.3); body (§17.2.2); comment (§17.13.4.2); customXml (§17.5.1.6); customXml (§17.5.1.4); customXml (§17.5.1.5); customXml (§17.5.1.3); deg (§22.1.2.26); del (§17.13.5.14); den (§22.1.2.28); dir (§17.3.2.8); docPartBody (§17.12.6); e (§22.1.2.32); endnote (§17.11.2); fldSimple (§17.16.19); fName (§22.1.2.37); footnote (§17.11.10); ftr (§17.10.3); hdr (§17.10.4); hyperlink (§17.16.22); ins (§17.13.5.18); lim (§22.1.2.52); moveFrom (§17.13.5.22); moveTo (§17.13.5.25); num (§22.1.2.75); oMath (§22.1.2.77); p (§17.3.1.22); rt (§17.3.3.24); rubyBase (§17.3.3.27); sdtContent (§17.5.2.34); sdtContent (§17.5.2.33); sdtContent (§17.5.2.35); sdtContent (§17.5.2.36); smartTag (§17.5.1.9); sub (§22.1.2.112); sup (§22.1.2.114); tbl (§17.4.38); tc (§17.4.66); tr (§17.4.79)

Attributes

Description

author (Annotation Author)

Specifies the author for an annotation within a WordprocessingML document.

If this attribute is omitted, then no author shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:author="Example Author">
  …
</…>

The author attribute specifies that the author of the current annotation is Example Author, which can be used as desired. end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).

date (Annotation Date)

Specifies the date information for an annotation within a WordprocessingML document. The use of this information is outside of the scope of /IEC 29500.

If this attribute is omitted, then no date information shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:date="2006-01-01T10:00:00">
  …
</…>

The date attribute specifies that the date of the current annotation is January 1st 2006 at , which can be used as desired. end example]

The possible values for this attribute are defined by the ST_DateTime simple type (§17.18.9).

id (Annotation Identifier)

Specifies a unique identifier for an annotation within a WordprocessingML document. The restrictions on the id attribute, if any, are defined by the parent XML element.

If this attribute is omitted, then the document is non-conformant.

[Example: Consider an annotation represented using the following WordprocessingML fragment:

<… w:id="1" … >
  …
</…>

The id attribute specifies that the ID of the current annotation is 1. This value is used to uniquely identify this annotation within the document content. end example]

The possible values for this attribute are defined by the ST_DecimalNumber simple type (§17.18.10).

[Note: The W3C XML Schema definition of this element’s content model (CT_TrackChange) is located in §A.1. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

Show:
© 2014 Microsoft