Show / Hide Table of Contents

# Namespace pdftron.PDF.Annots

### Classes

#### Caret

A Caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.

#### CheckBoxWidget

An object representing a check box used in a PDF Form.

#### Circle

Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page. When opened, they shall display a pop-up window containing the text of the associated note. The rectangle or ellipse shall be inscribed within the annotation rectangle defined by the annotation dictionary's Rect entry

#### ComboBoxWidget

An object representing a combo box used in a PDF Form.

#### FileAttachment

A file attachment annotation (PDF 1.3) contains a reference to a file, which typically shall be embedded in the PDF file.

#### FreeText

A free text annotation (PDF 1.3) displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text shall be always visible.

#### 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. When opened, they shall display a pop-up window containing the text of the associated note.

#### Ink

An ink annotation (PDF 1.3) represents a freehand 'scribble' composed of one or more disjoint paths. When opened, it shall display a pop-up window containing the text of the associated note.

#### Line

The purpose of a line annotation (PDF 1.3) is to display a single straight line on the page. When opened, it shall display a pop-up window containing the text of the associated note.

#### Link

A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.

#### ListBoxWidget

An object representing a List Box used in a PDF Form.

#### Markup

The meaning of an annotation's Contents entry varies by annotation type. Typically, it is the text that shall be displayed for the annotation or, if the annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, the Contents entry is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes. Many annotation types are defined as markup annotations because they are used primarily to mark up PDF documents. These annotations have text that appears as part of the annotation and may be displayed in other ways by a conforming reader, such as in a Comments pane. Markup annotations may be divided into the following groups:

- Free text annotations display text directly on the page. The annotation's Contents entry specifies the displayed text.
- Most other markup annotations have an associated pop-up window that may contain text. The annotation's Contents entry specifies the text that shall be displayed when the pop-up window is opened. These include text, line, square, circle, polygon, polyline, highlight,underline, squiggly-underline, strikeout, rubber stamp, caret, ink, and file attachment annotations.
- Sound annotations do not have a pop-up window but may also have associated text specified by the Contents entry. When separating text into paragraphs, a CARRIAGE RETURN (0Dh) shall be used and not, for example, a LINE FEED character (0Ah). A subset of markup annotations is called text markup annotations.

The remaining annotation types are not considered markup annotations:

- The pop-up annotation type shall not appear by itself; it shall be associated with a markup annotation that uses it to display text. If an annotation has no parent, the Contents entry shall represent the text of the annotation, otherwise it shall be ignored by a conforming reader.
- For all other annotation types (Link, Movie, Widget, PrinterMark, and TrapNet), the Contents entry shall provide an alternate representation of the annotation's contents in human-readable form, which is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.

#### Movie

The Class Movie.

#### PolyLine

Polyline annotations (PDF 1.5) display (open or closed) shapes of multiple edges on the page. Such polylines may have any number of vertices connected by straight lines. For open polylines, which is the default type of polylines, the first and last vertex are not implicitly connected. Closed polylines are polygons, whose first and last vertex are connected.

#### Polygon

Polygon annotation

#### Popup

A pop-up annotation (PDF 1.3) displays text in a pop-up window for entry and editing. It shall not appear alone but is associated with a markup annotation, its parent annotation, and shall be used for editing the parent's text. It shall have no appearance stream or associated actions of its own and shall be identified by the Popup entry in the parent's annotation dictionary.

#### PushButtonWidget

An object representing a push button used in a PDF Form.

#### RadioButtonGroup

An object representing a Group of Radio Buttons that can be used to create new Radio Buttons. If a group contains multiple buttons they will be connected.

#### RadioButtonWidget

An object representing a Radio Button used in a PDF Form.

#### Redaction

A redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document. The intent of redaction annotations is to enable the following process:

Redaction annotations provide a mechanism for the first step in the redaction process (content identification). This allows content to be marked for redaction in a non-destructive way, thus enabling a review process for evaluating potential redactions prior to removing the specified content.

Redaction annotations shall provide enough information to be used in the second phase of the redaction process (content removal). This phase is application-specific and requires the conforming reader to remove all content identified by the redaction annotation, as well as the annotation itself.

Conforming readers that support redaction annotations shall provide a mechanism for applying content removal, and they shall remove all traces of the specified content. If a portion of an image is contained in a redaction region, that portion of the image data shall be destroyed; clipping or image masks shall not be used to hide that data. Such conforming readers shall also be diligent in their consideration of all content that can exist in a PDF document, including XML Forms Architecture (XFA) content and Extensible Metadata Platform (XMP) content.

#### 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. When opened, it shall display a pop-up window containing the text of the associated note. Table'181 shows the annotation dictionary entries specific to this type of annotation.

#### Screen

A screen annotation (PDF 1.5) specifies a region of a page upon which media clips may be played. It also serves as an object from which actions can be triggered. 12.6.4.13, 'Rendition Actions' discusses the relationship between screen annotations and rendition actions.

#### SignatureWidget

An object representing a Signature used in a PDF Form. These Widgets can be signed directly, or signed using a DigitalSignatureField.

#### Sound

A sound annotation (PDF 1.2) shall 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. When the annotation is activated, the sound shall be played. The annotation shall behave like a text annotation in most ways, with a different icon (by default, a speaker) to indicate that it represents a sound.

#### Square

Square and circle annotations (PDF 1.3) shall display, respectively, a rectangle or an ellipse on the page. When opened, they shall display a pop-up window containing the text of the associated note. The rectangle or ellipse shall be inscribed within the annotation rectangle defined by the annotation dictionary's Rect entry

#### Squiggly

TextMarkup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ('squiggly') underlines (PDF 1.4) in the text of a document. When opened, they shall display a pop-up window containing the text of the associated note.

#### StrikeOut

TextMarkup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ('squiggly') underlines (PDF 1.4) in the text of a document. When opened, they shall display a pop-up window containing the text of the associated note.

#### Text

A text annotation represents a 'sticky note' attached to a point in the PDF document. When closed, the annotation shall appear as an icon; when open, it shall display a pop-up window containing the text of the note in a font and size chosen by the conforming reader. Text annotations shall not scale and rotate with the page; they shall behave as if the NoZoom and NoRotate annotation flags.

#### TextMarkup

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. When opened, they shall display a pop-up window containing the text of the associated note.

#### TextWidget

An object representing a Text Box used in a PDF Form.

#### 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. When opened, they shall display a pop-up window containing the text of the associated note.

#### 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. The FixedPrint entry of a watermark annotation dictionary shall be a dictionary that contains values for specifying the size and position of the annotation.

#### Widget

Interactive forms use widget annotations (PDF 1.2) to represent the appearance of fields and to manage user interactions. As a convenience, when a field has only a single associated widget annotation, the contents of the field dictionary and the annotation dictionary may be merged into a single dictionary containing entries that pertain to both a field and an annotation. NOTE This presents no ambiguity, since the contents of the two kinds of dictionaries do not conflict.

### Enums

#### FileAttachment.Icon

FileAttchment annotation icons

#### FreeText.IntentName

intentions of the FreeText annotation

#### Line.CapPos

Enumeration type describing the annotation's caption positioning. Valid values are e_Inline, meaning the caption shall be centered inside the line, and e_Top, meaning the caption shall be on top of the line.

#### Line.EndingStyle

For each line, one can choose a separate style for the start and the end of the line. The styles are defined by the "EndingStyle" enumeration.

#### Line.IntentType

the caption position of the Line annotation.

#### Link.HighlightingMode

highlighting mode is the visual effect that shall be used when the mouse button is pressed or held down inside its active area

#### Markup.BorderEffect

Markup border effects

#### PolyLine.IntentType

intent of the polygon or polyline annotation.

#### Redaction.QuadForm

This integer list represents the Quad Format of the Redaction annotation

#### RubberStamp.Icon

Icon type of the RubberStamp annotation

#### Screen.IconCaptionRelation

indicates where to position the text of the widget annotation's caption relative to its icon

#### Screen.ScaleCondition

spedifies the circumstances under which the icon shall be scaled inside the annotation rectangle.

#### Screen.ScaleType

Icon scale types

#### Sound.Icon

The Icon of the Sound annotation.

#### Text.Icon

type of icon corresponding with the Text annotation.

#### Widget.HighlightingMode

This enum specifies the Highlighting mode of the widget annotation.

#### Widget.IconCaptionRelation

Icon and Caption Relation of the Widget annotation

#### Widget.ScaleCondition

spedifies the circumstances under which the icon shall be scaled inside the annotation rectangle

#### Widget.ScaleType

scale types