Class
AnnotationCollection

Page annotations API for adding links, text markups, stamps, and other interactive elements to a PDF page.

Definition

Namespace:Telerik.Windows.Documents.Fixed.Model.Collections

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

cs-api-definition
public sealed class AnnotationCollection : DocumentElementCollection<Annotation, RadFixedPage>, IList<Annotation>, ICollection<Annotation>, IEnumerable<Annotation>, IEnumerable

Inheritance: objectDocumentElementCollectionBase<Annotation, RadFixedPage>DocumentElementCollection<Annotation, RadFixedPage>AnnotationCollection

Implements: ICollection<Annotation>IEnumerableIEnumerable<Annotation>IList<Annotation>

Inherited Members DocumentElementCollectionBase<Annotation, RadFixedPage>.GetEnumerator()DocumentElementCollectionBase<Annotation, RadFixedPage>.IndexOf(Annotation)DocumentElementCollectionBase<Annotation, RadFixedPage>.Insert(int, Annotation)DocumentElementCollectionBase<Annotation, RadFixedPage>.InsertRange(int, IEnumerable<Annotation>)DocumentElementCollectionBase<Annotation, RadFixedPage>.RemoveAt(int)DocumentElementCollectionBase<Annotation, RadFixedPage>.RemoveRange(int, int)DocumentElementCollectionBase<Annotation, RadFixedPage>.Clear()DocumentElementCollectionBase<Annotation, RadFixedPage>.Contains(Annotation)DocumentElementCollectionBase<Annotation, RadFixedPage>.CopyTo(Annotation[], int)DocumentElementCollectionBase<Annotation, RadFixedPage>.Remove(Annotation)DocumentElementCollectionBase<Annotation, RadFixedPage>.Add(Annotation)DocumentElementCollectionBase<Annotation, RadFixedPage>.CountDocumentElementCollectionBase<Annotation, RadFixedPage>.this[int]

Constructors

AnnotationCollection(RadFixedPage)

Create an annotations collection for the specified page and manage interactive PDF annotations.

Declaration

cs-api-definition
public AnnotationCollection(RadFixedPage parent)

Parameters

parent

RadFixedPage

The parent.

Methods

AddHighlight(Rect)

Add a highlight annotation to emphasize text or content with a background highlight.

Declaration

cs-api-definition
public TextMarkupAnnotation AddHighlight(Rect rect)

Parameters

rect

Rect

The rectangle defining the area to highlight in page coordinates.

Returns

TextMarkupAnnotation

The created highlight annotation.

AddLine(Point, Point)

Add a line annotation that draws a straight line between two points.

Declaration

cs-api-definition
public LineAnnotation AddLine(Point start, Point end)

Parameters

start

Point

The starting point of the line in page coordinates.

end

Point

The ending point of the line in page coordinates.

Returns

LineAnnotation

The created line annotation.

Add a link annotation that executes the specified action when activated.

Declaration

cs-api-definition
public Link AddLink(Action action)

Parameters

action

Action

The action to execute when the link is clicked.

Returns

Link

The newly created link annotation.

Add a link annotation that navigates to the specified destination within the document.

Declaration

cs-api-definition
public Link AddLink(Destination destination)

Parameters

destination

Destination

The document destination to navigate to when the link is clicked.

Returns

Link

The newly created link annotation.

Add a link annotation that navigates to the given named destination within the document.

Declaration

cs-api-definition
public Link AddLink(NamedDestination namedDestination)

Parameters

namedDestination

NamedDestination

The named destination to navigate to when the link is clicked.

Returns

Link

The newly created link annotation.

AddPopup(MarkupAnnotation)

Add a popup annotation that displays additional content for a parent markup annotation.

Declaration

cs-api-definition
public PopupAnnotation AddPopup(MarkupAnnotation parent)

Parameters

parent

MarkupAnnotation

The parent markup annotation that this popup will be associated with.

Returns

PopupAnnotation

The created popup annotation.

AddSquiggly(Rect)

Add a squiggly underline annotation to mark text with a wavy underline.

Declaration

cs-api-definition
public TextMarkupAnnotation AddSquiggly(Rect rect)

Parameters

rect

Rect

The rectangle defining the bounds of the squiggly underline in page coordinates.

Returns

TextMarkupAnnotation

The newly created squiggly underline annotation.

AddStamp(Rect)

Add a stamp annotation that displays a rubber stamp-like visual or text.

Declaration

cs-api-definition
public StampAnnotation AddStamp(Rect rect)

Parameters

rect

Rect

The rectangle defining the area for the stamp in page coordinates.

Returns

StampAnnotation

The created stamp annotation.

AddStrikeout(Rect)

Add a strikeout annotation to draw a line through text.

Declaration

cs-api-definition
public TextMarkupAnnotation AddStrikeout(Rect rect)

Parameters

rect

Rect

The rectangle defining the area to strike out in page coordinates.

Returns

TextMarkupAnnotation

The created strikeout annotation.

AddText(Rect)

Add a text annotation that shows a pop-up note when activated.

Declaration

cs-api-definition
public TextAnnotation AddText(Rect rect)

Parameters

rect

Rect

The rectangle defining the clickable area for the text annotation in page coordinates.

Returns

TextAnnotation

The created text annotation.

AddUnderline(Rect)

Add an underline annotation to draw a straight underline beneath text.

Declaration

cs-api-definition
public TextMarkupAnnotation AddUnderline(Rect rect)

Parameters

rect

Rect

The rectangle defining the area to underline in page coordinates.

Returns

TextMarkupAnnotation

The created underline annotation.

OnAfterAdd(Annotation)

Executes the action after the item is added to the collection.

Declaration

cs-api-definition
protected override void OnAfterAdd(Annotation item)

Parameters

item

Annotation

The annotation that has been added to the collection.

Overrides DocumentElementCollectionBase<Annotation, RadFixedPage>.OnAfterAdd(Annotation)

OnAfterRemove(Annotation)

Executes the action after the item is removed from the collection.

Declaration

cs-api-definition
protected override void OnAfterRemove(Annotation item)

Parameters

item

Annotation

The annotation that has been removed from the collection.

Overrides DocumentElementCollectionBase<Annotation, RadFixedPage>.OnAfterRemove(Annotation)