Annotations

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...

Classes
class	PageAnnotationsHandle
	An array of annotation dictionaries that shall contain indirect references to all AnnotationHandle associated with the page. More...
class	AnnotationHandle
	Base class for all annotations. More...
class	LinkAnnotationHandle
	A link annotation represents either a hypertext link to a DestinationHandle elsewhere in the document or an Action to be performed. More...

Enumerations
enum	AnnotationType {   AnnotationType_Text = 0, AnnotationType_Link, AnnotationType_FreeText, AnnotationType_Line,   AnnotationType_Square, AnnotationType_Circle, AnnotationType_Polygon, AnnotationType_PolyLine,   AnnotationType_Highlight, AnnotationType_Underline, AnnotationType_Squiggly, AnnotationType_StrikeOut,   AnnotationType_RubberStamp, AnnotationType_Caret, AnnotationType_Ink, AnnotationType_Popup,   AnnotationType_FileAttachment, AnnotationType_Sound, AnnotationType_Movie, AnnotationType_Widget,   AnnotationType_Screen, AnnotationType_PrinterMark, AnnotationType_TrapNetwork, AnnotationType_Watermark,   AnnotationType_TripleD, AnnotationType_Redaction }
	Required for conversion to derived types. More...

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.

For more details please visit section 12.5 - Annotations.

Enumeration Type Documentation

AnnotationType

enum AnnotationType

Required for conversion to derived types.

Enumerator
AnnotationType_Text	A text annotation represents a "sticky note" attached to a point in the PDF document.
AnnotationType_Link	A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed
AnnotationType_FreeText	A free text annotation (PDF 1.3) displays text directly on the page.
AnnotationType_Line	The purpose of a line annotation (PDF 1.3) is to display a single straight line on the page.
AnnotationType_Square	Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page.
AnnotationType_Circle	Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page.
AnnotationType_Polygon	Polygon annotations (PDF 1.5) display closed polygons on the page.
AnnotationType_PolyLine	Polyline annotations (PDF 1.5) are similar to polygons, except that the first and last vertex are not implicitly connected.
AnnotationType_Highlight	Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document.
AnnotationType_Underline	Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document.
AnnotationType_Squiggly	Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document.
AnnotationType_StrikeOut	Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ("squiggly") underlines (PDF 1.4) in the text of a document.
AnnotationType_RubberStamp	A rubber stamp annotation (PDF 1.3) displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.
AnnotationType_Caret	A caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.
AnnotationType_Ink	An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths.
AnnotationType_Popup	A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing.
AnnotationType_FileAttachment	A file attachment annotation (PDF 1.3) contains a reference to a file, which typically shall be embedded in the PDF file.
AnnotationType_Sound	A sound annotation (PDF 1.2) shall be analogous to a text annotation except that instead of a text note, it contains sound recorded from the computer's microphone or imported from a file.
AnnotationType_Movie	A movie annotation (PDF 1.2) contains animated graphics and sound to be presented on the computer screen and through the speakers.
AnnotationType_Widget	Interactive forms use widget annotations (PDF 1.2) to represent the appearance of fields and to manage user interactions.
AnnotationType_Screen	A screen annotation (PDF 1.5) specifies a region of a page upon which media clips may be played.
AnnotationType_PrinterMark	A printer's mark annotation (PDF 1.4) represents a graphic symbol, such as a registration target,colour bar, or cut mark, that may be added to a page to assist production personnel in identifying components of a multiple-plate job and maintaining consistent output during production.
AnnotationType_TrapNetwork	A trap network annotation (PDF 1.3) may be used to define the trapping characteristics for a page of a PDF document.
AnnotationType_Watermark	A watermark annotation (PDF 1.6) shall be used to represent graphics that shall be printed at a fixed size and position on a page, regardless of the dimensions of the printed page.
AnnotationType_TripleD	3D annotations (PDF 1.6) are the means by which 3D artwork shall be represented in a PDF document.
AnnotationType_Redaction	A redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document.