Share via


AnnotationReferenceMark Class

Comment Information Block.When the object is serialized out as xml, its qualified name is w:annotationRef.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.EmptyType
        DocumentFormat.OpenXml.Wordprocessing.AnnotationReferenceMark

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

Syntax

'Declaration
Public Class AnnotationReferenceMark _
    Inherits EmptyType
'Usage
Dim instance As AnnotationReferenceMark
public class AnnotationReferenceMark : EmptyType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.13.1.1 annotationRef (Comment Information Block)

This element specifies the presence of an annotation reference mark at the current location in the comment. An annotation reference mark is an information block that represents the metadata about the current comment within the document. This annotation reference mark should typically consist of the initials and a unique integer associated with its position in the document, but can be displayed in any desired format.

If this element is omitted from a single comment's contents, then an annotation reference mark can be added at the start of the comment in reading order (right in a right-to-left paragraph or left in a left-to-right paragraph). As well, an annotation reference mark can be relocated as desired within a comment's content.

[Example: Consider a document with text with an annotated comment as follows:

DocumentFormat.OpenXml.Wordprocessing.AnnotationRe

This comment is represented as the following WordprocessingML fragment:

<w:comment … w:initials="User">
  <w:p>
      <w:r>
      <w:annotationRef />
    </w:r>
    …
  </w:p>
</w:comment>

The annotationRef element specifies that the comment must start with an annotation reference mark. In this example, this mark is displayed as a combination of the user initial, User, and a unique sequential number, 1. end example]

Parent Elements

r (§22.1.2.87); r (§17.3.2.25)

[Note: The W3C XML Schema definition of this element’s content model (CT_Empty) 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

Reference

AnnotationReferenceMark Members

DocumentFormat.OpenXml.Wordprocessing Namespace