BookmarkEnd Class

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

Inheritance Hierarchy


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


Public Class BookmarkEnd _
    Inherits MarkupRangeType
Dim instance As BookmarkEnd
public class BookmarkEnd : MarkupRangeType


[ISO/IEC 29500-1 1st Edition] bookmarkEnd (Bookmark End)

This element specifies the end of a bookmark within a WordprocessingML document. This end marker is matched with the appropriately paired start marker by matching the value of the id attribute from the associated bookmarkStart element.

If no bookmarkStart element exists prior to this element in document order with a matching id attribute value, then the document is non-conformant.

[Example: Consider a document with a bookmark which spans half of paragraph one, and part of paragraph two. The following WordprocessingML illustrates an example of content which fufills this constraint:

<w:t xml:space="preserve">This is sentence one.</w:t>
<w:bookmarkStart w:id="0" w:name="testing123"/>
<w:t>This is sentence two.</w:t>
<w:t xml:space="preserve">This </w:t>
<w:bookmarkEnd w:id="0"/>
<w:t>is sentence three.</w:t>

The bookmarkEnd element specifies the end of the region for the bookmark whose bookmarkStart element has an id attribute value of 0. In this case, this refers to the testing123 bookmark. end example]

Parent Elements

bdo (§; body (§17.2.2); comment (§; customXml (§; customXml (§; customXml (§; customXml (§; deg (§; del (§; den (§; dir (§; docPartBody (§17.12.6); e (§; endnote (§17.11.2); fldSimple (§17.16.19); fName (§; footnote (§17.11.10); ftr (§17.10.3); hdr (§17.10.4); hyperlink (§17.16.22); ins (§; lim (§; moveFrom (§; moveTo (§; num (§; oMath (§; p (§; rt (§; rubyBase (§; sdtContent (§; sdtContent (§; sdtContent (§; sdtContent (§; smartTag (§; sub (§; sup (§; tbl (§17.4.38); tc (§17.4.66); tr (§17.4.79)



displacedByCustomXml (Annotation Marker Relocated For Custom XML Markup)

Specifies that the parent annotation's placement shall be directly linked with the location of the physical presentation of a custom XML element in the document. This element only has an effect when the custom XML element is block-level (i.e. surrounds an entire paragraph), as in this scenario the logical and physical placement of the annotation and custom XML element can differ.

Specifically, in this case, the custom XML is presented *around* the block-level object it encloses (the paragraph, table, table row, or table cell), but is physically represented within that same object (i.e. within the paragraph, table, table row or table cell). This requirement stems from the fact that there is no location for the location of the annotation within the document at its logical location (around a table, for example).

If this element is omitted, then the annotation shall be anchored inside of all block-level custom XML elements in the paragraph. If this element is present, but no block-level custom XML tag is located at the position it specifies (before or after), then it shall be ignored.

[Example: Consider a paragraph with block level custom XML markup and two comment anchor annotations (one before and one after the custom XML element's physical representation), as follows:


Since all three of these items are around the entire paragraph, they are stored outside of the paragraph. However, in order to ensure that their relative positions are stored correctly, any annotation which must be displaced by the physical custom XML element specifies this information, resulting in the following WordprocessingML:

<w:commentRangeStart w:id="0" />
<w:commentRangeStart w:id="1" w:displaced byCustomXml="next" />
<w:customXml w:element="spec" … />

The displacedByCustomXml attribute specifies that even though all three of these items are around the paragraph and is moved inside the paragraph to be represented physically, the comment with ID 0 must be inside the custom XML, but the comment with ID 1 must be displaced to stay outside of the relative location of the next custom XML element (the spec element). end example]

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

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_MarkupRange) is located in §A.1. end note]

© ISO/IEC29500: 2008.

Thread Safety

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

See Also


BookmarkEnd Members

DocumentFormat.OpenXml.Wordprocessing Namespace