Edit this page

Annotations

The structure of a RadDocument is normally determined by the content in it, i.e. the text is distributed in Paragraphs and Sections depending on the layout desired by the end user.The same applies to the presence of Hyperlinks and Images.

When it comes to how the text is split in spans, this depends on the formatting of the document and cannot be explicitly controlled, i.e. it is not possible to split some text in two spans if the formatting of the two parts is identical or to have text with different formatting be part of one span.

Since the life cycle of spans is determined by the document, embedding custom semantic information in spans is inappropriate. This is what Annotations are made for.

This article will list the types of annotations that are included in the document model. If you would like to implement custom ones in order to suit application-specific scenarios, you can follow the guidelines in
this article.

AnnotationMarkerBase

AnnotationMarkerBase is the base class of all annotation markers. It inherits from Inline and as an inline element can be included to the Inlines of a Paragraph in a document.

Its immediate successors in the document model hierarchy are FloatingBlocks (FloatingImageBlocks and FloatingUIContainers) - used for adding floating single items in the document.

The functionality of AnnotationMarkerBase is extended by its inheritors AnnotationRangeStart and AnnotationRangeEnd. The idea behind these elements is to be paired together to mark a part of the document. This is what enables "annotating" pieces of the document.

For a picture of the document hierarchy please see this topic.

AnnotationMarkerBase and AnnotationRangeStart and AnnotationRangeEnd consequently have the following members:

  • AnnotationID - each annotation has a unique ID. In the case of annotation ranges, the IDs of the range start and range end elements are the same.

  • SkipPositionBefore - this property is related to the implementation of the "walk of the caret" - i.e. the positions which the caret can occupy. As annotation ranges are normally not taken into account when traversing the document with the arrow keys of the keyboard, placing the cursor at the place of an annotation marker should also move the caret at this place in the document. This property determines if the caret will be put before or after the annotation marked. If the value of this property is true for an annotation range start, then if you move the caret to the annotation start and start typing, the newly inserted text will be considered as part of the annotation. Vice versa, if it is set to false, the typed text will be inserted before the annotation. Needless to say, the behavior of AnnotationRangeEnds is also controlled in the same manner.

  • SkipPositionAfter - a negation of the SkipPositionBefore property. If the position before the marker is skipped, then the one after it must not be skipped. Exactly one of the positions must be skipped.

  • IsCopyable - determines if the range marker can be copy/pasted. Note that the value for annotation range starts and their respective ends must be the same. Otherwise, if only one of the markers is copied, the structure of the document will become invalid once the range is pasted.

  • DeleteBehavior, BackspaceBehavior, DeleteSelectedBehavior - these behaviors determine the behavior of the annotations when a delete is initiated. They are of type AnnotationMarkerDeleteBehavior and can obtain values from the AnnotationMarkerDeleteBehavior enum:

    • PreserveAnnotation - preserves the annotation, but the content can be modified. Can be used for Backspace and DeleteBehavior;

    • SelectAnnotation - selects the annotation. Can be used for Backspace and DeleteBehavior;

    • RemoveAnnotation - removes the annotation, but leaves its content. Can be used for Backspace, Delete and DeleteSelectedBehavior;

    • SelectAnnotationMarker - selects the annotation marker. Can be used for Backspace and DeleteBehavior.

Annotation Types

RadDocument has implementations of the following annotation range types (each annotation start class has a corresponding ~End element):

  • BookmarkRangeStart - specifies a place in the document where a bookmark has been inserted. More information can be found here;

  • CodeAnnotationRangeStart - these type of ranges surround code blocks. More information can be found here;

  • CommentRangeStart - used for inserting comments in the document; More information can be found here;

  • FieldRangeStartBase - a base class for the following FieldRange annotations:

    • FieldRangeStart - the type of annotations inserted along with Fields. More information on fields can be found here;

    • HyperlinkRangeStart - the annotations that surround hyperlinks. The hyperlink functionality is a topic of discussion in this article;

    • MarkRangeStartBase - a base class for the following annotation starts:

      • NoteRangeStartBase - a base class for the following annotations:

        • EndnoteRangeStart - the annotations that specify the place in the document where an endnote occurs;

        • FootnoteRangeStart - the annotations that specify the place in the document where a footnote is inserted;

      • NoteReferenceMarkStart - the annotation that fulfill the link from a note to the main document.

    • ReadOnlyRangeStart - a type of annotations that can be inserted in the document in order to make their content read only.

  • PermissionRangeStart - the annotation ranges used in document protection.

  • RevisionRangeStart - the annotations used in track changes. A base class for the following annotations:

    • DeleteRangeStart - denotes content that has been deleted when TrackChanges is enabled;

    • InsertRangeStart - surround content inserted at a time when TrackChanges has been turned on.

Serialization

Format Persistence of Annotations
XAML All annotations are persisted
Docx All annotations are persisted with the exception of ReadOnlyRangeStart/End and CodeFormattingRangeStart/End.
RTF HyperlinkRangeStart/End, PermissionRangeStart/End and FieldRangeStart/End are persisted.
HTML HyperlinkRangeStart/End are persisted.

See Also