PdfTextAnnotation Class

Represents a sticky-note style annotation displayed as a clickable icon on a specific page of the PDF. Clicking the icon opens a popup with the note text. The annotation also appears in the viewer's Comments panel alongside any other comments. Use Create(String, Int32, Int32, Int32) to create an instance, then pass it to AddTextAnnotation on the document, editor or merger

Definition

Namespace: HiQPdf.Next
Assembly: HiQPdf.Next (in HiQPdf.Next.dll) Version: 18.9.2
C#
public class PdfTextAnnotation
Inheritance
Object    PdfTextAnnotation

Properties

Author Optional author name displayed in the popup title and the Comments panel (for example, "Reviewed by John"). When null, no author is recorded
Contents The note text shown in the popup and the Comments panel. Required for accessibility (PDF/UA) -- the value supplied at construction time is also used as the screen-reader text
Height Height of the icon, in points. Default is 24
Icon Icon used for the annotation marker. Default is Note
Open When true, the popup is displayed expanded as soon as the page is opened. Default is false
PageNumber 1-based page number on which the annotation icon is placed
Width Width of the icon, in points. Default is 24
X The X coordinate of the annotation icon's top-left corner, in points, measured from the left edge of the page content area
Y The Y coordinate of the annotation icon's top-left corner, in points, measured from the top of the page content area

Methods

Create Creates a sticky-note text annotation. The note text is required and is used both as the popup content and as the accessibility description for screen readers
Equals
(Inherited from Object)
Finalize
(Inherited from Object)
GetHashCode
(Inherited from Object)
GetType
(Inherited from Object)
MemberwiseClone
(Inherited from Object)
ToString
(Inherited from Object)

See Also