Annotation Classes

  • Return true if this annotation is classified as a markup annotation.

    See more

    Declaration

    Objective-C

    @interface PTAnnot : NSObject

    Swift

    class PTAnnot : NSObject

    Return Value

    boolean value, true if this annotation is classified as a markup annotation.

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

    See more

    Declaration

    Objective-C

    @interface PTCaret : PTMarkup

    Swift

    class PTCaret : PTMarkup
  • A Circle annotation is a type of markup annotation that displays an ellipse on the page. When opened, it can display a pop-up window containing the text of the associated note. The ellipse may be inscribed and possibly padded within the annotation rectangle defined by the annotation dictionary’s Rect entry.

    See more

    Declaration

    Objective-C

    @interface PTCircle : PTMarkup

    Swift

    class PTCircle : PTMarkup
  • A file attachment annotation contains a reference to a file, which may be embedded in the PDF document.

    See more

    Declaration

    Objective-C

    @interface PTFileAttachment : PTMarkup

    Swift

    class PTFileAttachment : PTMarkup
  • A FreeText annotation (PDF 1.3) displays text directly on the page. Unlike an ordinary Text annotation, a FreeText annotation has no open or closed state; The content of the FreeText annotation is always visible instead of being displayed in a popup window.

    See more

    Declaration

    Objective-C

    @interface PTFreeText : PTMarkup

    Swift

    class PTFreeText : PTMarkup
  • A HighlightAnnot annotation covers a word or a group of contiguous words with partially transparent color.

    See more

    Declaration

    Objective-C

    @interface PTHighlightAnnot : PTTextMarkup

    Swift

    class PTHighlightAnnot : PTTextMarkup
  • 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.

    See more

    Declaration

    Objective-C

    @interface PTInk : PTMarkup

    Swift

    class PTInk : PTMarkup
  • A line annotation (PDF 1.3) is used to display a single straight line on the page. When opened, it should display a pop-up window containing the text of the associated note.

    See more

    Declaration

    Objective-C

    @interface PTLineAnnot : PTMarkup

    Swift

    class PTLineAnnot : PTMarkup
  • A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.

    See more

    Declaration

    Objective-C

    @interface PTLink : PTAnnot

    Swift

    class PTLink : PTAnnot
  • Markup is a base class for a number of annotations types that are used 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.
  • A subset of markup annotations are intended to markup text of a document (e.g. highlight, strikeout, jagged, underline) and they are derived from TextMarkup base class.

  • Note

    The pop-up annotation type must not appear by itself; it must be associated with a markup annotation that uses it to display text.

    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. When separating text into paragraphs, a CARRIAGE RETURN (0Dh) must be used.

    See more

    Declaration

    Objective-C

    @interface PTMarkup : PTAnnot

    Swift

    class PTMarkup : PTAnnot
  • A movie annotation contains animated graphics and sound to be presented on the computer screen and through the speakers. When the annotation is activated, the movie is played.

    See more

    Declaration

    Objective-C

    @interface PTMovie : PTAnnot

    Swift

    class PTMovie : PTAnnot
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface PTPolygon : PTPolyLine

    Swift

    class PTPolygon : PTPolyLine
  • This header defines classes for the Polygon and PolyLine annotations. Polygon annotations (PDF 1.5) display closed polygons on the page. Such polygons may have any number of vertices connected by straight lines. Polyline annotations (PDF 1.5) are similar to polygons, except that the first and last vertex are not implicitly connected.

    See more

    Declaration

    Objective-C

    @interface PTPolyLine : PTLineAnnot

    Swift

    class PTPolyLine : PTLineAnnot
  • 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.

    See more

    Declaration

    Objective-C

    @interface PTPopup : PTAnnot

    Swift

    class PTPopup : PTAnnot
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface PTRedactionAnnot : PTMarkup

    Swift

    class PTRedactionAnnot : PTMarkup
  • A RubberStamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.

    See more

    Declaration

    Objective-C

    @interface PTRubberStamp : PTMarkup

    Swift

    class PTRubberStamp : PTMarkup
  • 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.

    See more

    Declaration

    Objective-C

    @interface PTScreen : PTAnnot

    Swift

    class PTScreen : PTAnnot
  • A Sound annotation represents a sound recording attached to a point in the PDF document. When closed, this annotation appear as an icon; when open and activated, a sound record from the computer’s microphone or imported from a file associated with this annotation is played.The icon of this annotation by default is a speaker.

    See more

    Declaration

    Objective-C

    @interface PTSound : PTMarkup

    Swift

    class PTSound : PTMarkup
  • Square annotation is used to display a rectangle on the page. When opened, a square annotation can display a pop-up window containing the text of the associated note. The rectangle may be inscribed and possibly padded within the annotation rectangle defined by the annotation dictionary’s Rect entry.

    See more

    Declaration

    Objective-C

    @interface PTSquare : PTMarkup

    Swift

    class PTSquare : PTMarkup
  • A Squiggly annotation shows as a wavy line segment across the bottom of a word or a group of contiguous words.

    See more

    Declaration

    Objective-C

    @interface PTSquiggly : PTTextMarkup

    Swift

    class PTSquiggly : PTTextMarkup
  • A StrikeOut annotation shows as a line segment crossing out a word or a group of contiguous words.

    See more

    Declaration

    Objective-C

    @interface PTStrikeOut : PTTextMarkup

    Swift

    class PTStrikeOut : PTTextMarkup
  • 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 do not scale and rotate with the page (i.e. they should behave as if the NoZoom and NoRotate annotation flags).

    See more

    Declaration

    Objective-C

    @interface PTText : PTMarkup

    Swift

    class PTText : PTMarkup
  • A TextMarkup is a base class for highlight, underline, strikeout, and squiggly annotations.

    See more

    Declaration

    Objective-C

    @interface PTTextMarkup : PTMarkup

    Swift

    class PTTextMarkup : PTMarkup
  • An Underline annotation shows as a line segment across the bottom of a word or a group of contiguous words.

    See more

    Declaration

    Objective-C

    @interface PTUnderline : PTTextMarkup

    Swift

    class PTUnderline : PTTextMarkup
  • A Watermark annotation is an annotation that is printed at a fixed size and position on a page, regardless of the dimensions of the printed page.

    See more

    Declaration

    Objective-C

    @interface PTWatermark : PTAnnot

    Swift

    class PTWatermark : PTAnnot
  • 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.

    See more

    Declaration

    Objective-C

    @interface PTWidget : PTAnnot

    Swift

    class PTWidget : PTAnnot