ClassAnnotationCollection
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:
public sealed class AnnotationCollection : DocumentElementCollection<Annotation, RadFixedPage>, IList<Annotation>, ICollection<Annotation>, IEnumerable<Annotation>, IEnumerable
Inheritance: objectDocumentElementCollectionBase<Annotation, RadFixedPage>DocumentElementCollection<Annotation, RadFixedPage>AnnotationCollection
Implements:
Inherited Members
Constructors
AnnotationCollection(RadFixedPage)
Create an annotations collection for the specified page and manage interactive PDF annotations.
Declaration
public AnnotationCollection(RadFixedPage parent)
Parameters
parent
The parent.
Methods
AddHighlight(Rect)
Add a highlight annotation to emphasize text or content with a background highlight.
Declaration
public TextMarkupAnnotation AddHighlight(Rect rect)
Parameters
rect
The rectangle defining the area to highlight in page coordinates.
Returns
The created highlight annotation.
AddLine(Point, Point)
Add a line annotation that draws a straight line between two points.
Declaration
public LineAnnotation AddLine(Point start, Point end)
Parameters
start
The starting point of the line in page coordinates.
end
The ending point of the line in page coordinates.
Returns
The created line annotation.
AddLink(Action)
Add a link annotation that executes the specified action when activated.
AddLink(Destination)
Add a link annotation that navigates to the specified destination within the document.
Declaration
public Link AddLink(Destination destination)
Parameters
destination
The document destination to navigate to when the link is clicked.
Returns
The newly created link annotation.
AddLink(NamedDestination)
Add a link annotation that navigates to the given named destination within the document.
Declaration
public Link AddLink(NamedDestination namedDestination)
Parameters
namedDestination
The named destination to navigate to when the link is clicked.
Returns
The newly created link annotation.
AddPopup(MarkupAnnotation)
Add a popup annotation that displays additional content for a parent markup annotation.
Declaration
public PopupAnnotation AddPopup(MarkupAnnotation parent)
Parameters
parent
The parent markup annotation that this popup will be associated with.
Returns
The created popup annotation.
AddSquiggly(Rect)
Add a squiggly underline annotation to mark text with a wavy underline.
Declaration
public TextMarkupAnnotation AddSquiggly(Rect rect)
Parameters
rect
The rectangle defining the bounds of the squiggly underline in page coordinates.
Returns
The newly created squiggly underline annotation.
AddStamp(Rect)
Add a stamp annotation that displays a rubber stamp-like visual or text.
Declaration
public StampAnnotation AddStamp(Rect rect)
Parameters
rect
The rectangle defining the area for the stamp in page coordinates.
Returns
The created stamp annotation.
AddStrikeout(Rect)
Add a strikeout annotation to draw a line through text.
Declaration
public TextMarkupAnnotation AddStrikeout(Rect rect)
Parameters
rect
The rectangle defining the area to strike out in page coordinates.
Returns
The created strikeout annotation.
AddText(Rect)
Add a text annotation that shows a pop-up note when activated.
Declaration
public TextAnnotation AddText(Rect rect)
Parameters
rect
The rectangle defining the clickable area for the text annotation in page coordinates.
Returns
The created text annotation.
AddUnderline(Rect)
Add an underline annotation to draw a straight underline beneath text.
Declaration
public TextMarkupAnnotation AddUnderline(Rect rect)
Parameters
rect
The rectangle defining the area to underline in page coordinates.
Returns
The created underline annotation.
OnAfterAdd(Annotation)
Executes the action after the item is added to the collection.
Declaration
protected override void OnAfterAdd(Annotation item)
Parameters
item
The annotation that has been added to the collection.
Overrides
OnAfterRemove(Annotation)
Executes the action after the item is removed from the collection.
Declaration
protected override void OnAfterRemove(Annotation item)
Parameters
item
The annotation that has been removed from the collection.
Overrides