An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard. More...
Inheritance diagram for Opait.Pdf.Annotations.PdfAnnot:
Public Member Functions | |
| PdfAnnot (PdfPage page, PdfAnnotType type, PdfRectangle rect) | |
| Intializes a new instance of the PdfAnnot class. More... | |
| override string | ToString () |
Properties | |
| PdfPage | PdfPage [get] |
| The PDF page that this annotation dictionary belongs to. Note: annotation dictionaries cannot be shared among pages. | |
| PdfAnnotType | AnnotType [get, set] |
| The type of annotation that this dictionary describes. | |
| PdfRectangle | Rectangle [get, set] |
| The annotation rectangle, defining the location of the annotation on the page in default user space units. | |
| PdfAnnotBorder | BorderStyle [get, set] |
| The annotation border style. | |
| double | BorderWidth [get, set] |
| The annotation border width (default is 1). | |
| double[] | BorderDash [get, set] |
| Gets or sets dashed line pattern, as dash-dot array with zero phase. | |
| string | Contents [get, set] |
| Text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. | |
| PdfAnnotFlags | AnnotFlags [get, set] |
| A set of flags specifying various characteristics of the annotation. | |
| PdfColor | Color [get, set] |
| Gets or sets the color to be used for: The background of the annotation’s icon when closed. The title bar of the annotation’s pop-up window. The border of a link annotation. | |
| PdfForm | NormalAppearance [get, set] |
| Gets or sets the normal appearance stream. The normal appearance is used when the annotation is not interacting with the user. This appearance is also used for printing the annotation. | |
| PdfForm | RolloverAppearance [get, set] |
| Gets or sets the optional rollover appearance stream. The rollover appearance is used when the user moves the cursor into the annotation’s active area without pressing the mouse button. | |
| PdfForm | DownAppearance [get, set] |
| Gets or sets the optional down appearance stream. The down appearance is used when the mouse button is pressed or held down within the annotation’s active area. | |
Detailed Description
An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.
Constructor & Destructor Documentation
◆ PdfAnnot()
| Opait.Pdf.Annotations.PdfAnnot.PdfAnnot | ( | PdfPage | page, |
| PdfAnnotType | type, | ||
| PdfRectangle | rect | ||
| ) |
Intializes a new instance of the PdfAnnot class.
- Parameters
-
page The PDF page that the annotation belongs to. type The sub-type of the annotation mark. rect The annotation rectangle.
