Annot

The Constant e_3D.

The Constant e_Caret.

The Constant e_Circle.

The Constant e_FileAttachment.

The Constant e_FreeText.

The Constant e_Highlight.

The Constant e_Ink.

The Constant e_Line.

The Constant e_Link.

The Constant e_Movie.

The Constant e_Polygon.

The Constant e_Polyline.

The Constant e_Popup.

The Constant e_PrinterMark.

The Constant e_Projection.

The Constant e_Redact.

The Constant e_RichMedia.

The Constant e_Screen.

The Constant e_Sound.

The Constant e_Square.

The Constant e_Squiggly.

The Constant e_Stamp.

The Constant e_StrikeOut.

PDF supports the standard annotation types listed in the following enumeration (plug-in extensions may add new annotation types):.

The Constant e_TrapNet.

The Constant e_Underline.

The Constant e_Unknown.

The Constant e_Watermark.

The Constant e_Widget.

Triggered when the annotation is activated. if present, takes precedence over U entry (e_action_trigger_annot_up)

Triggered when the annotation loses the input focus

Triggered when the mouse button is pressed inside the annotation's active area

Triggered when the cursor enters the annotation's active area

Triggered when the cursor exits the annotation's active area

Triggered when the annotation receives the input focus

Triggered when the page containing the annotation is closed

Triggered when the page containing the annotation is no longer visible in the interactive PDF processor's user interface

Triggered when the page containing the annotation is opened

Triggered when the page containing the annotation becomes visible

Triggered when the mouse button is released inside the annotation's active area

The Constant e_down.

The Constant e_hidden.

Flags specifying various characteristics of the annotation. - If e_invisible is set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any. - If e_hidden is set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. - If e_print is set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page. - If e_no_zoom is set, do not scale the annotation's appearance to match the magnification of the page. - If e_no_rotate is set, do not rotate the annotation's appearance to match the rotation of the page. - If e_no_view is set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction. - If e_read_only is set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions. - If e_locked is set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field. - If e_toggle_no_view is set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it. - If e_locked_contents is set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.

The Constant e_locked.

The Constant e_locked_contents.

The Constant e_no_rotate.

The Constant e_no_view.

The Constant e_no_zoom.

An annotation can define as many as three separate appearances: The normal appearance is used when the annotation is not interacting with the user. This appearance is also used for printing the annotation. The rollover appearance is used when the user moves the cursor into the annotation's active area without pressing the mouse button. The down appearance is used when the mouse button is pressed or held down within the annotation's active area.

The Constant e_print.

The Constant e_read_only.

The Constant e_rollover.

The Constant e_toggle_no_view.

Create an annotation and initialize it using given Cos/SDF object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Create an empty annotation.

Get the struct parent of an annotation. (Required if the annotation is a structural content item; PDF'1.3)

Note: The StructParent is the integer key of the annotation's entry in the structural parent tree.

Creates a new annotation of a given type, in the specified document. Because the newly created annotation does not contain any properties specific to a given annotation type, it is faster to create an annotation using type specific Annot.Create method.

Deletes custom data associated with the given key.

Compares two annotations for equality. The comparison will return true only if both annotations share the same underlying SDF/Cos object.

Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page. Annotation 'flattening' refers to the operation that changes active annotations (such as markup, widgets, 3D models, etc.) into a static area that is part of the PDF document, just like the other text and images in the document.

Note: an alternative approach to set the annotation as read only is using Annot.SetFlag(Annot::e_read_only, true) method. Unlike Annot.SetFlag(...), the result of Flatten() operation can not be programatically reversed.

Get the annotation's active appearance state.

Get the annotation's appearance for the given combination of annotation and appearance states.

Get the annotation's appearance for the given combination of annotation and appearance states.

Get the annotation's appearance for the given combination of annotation and appearance states.

Get the border style for the annotation. Typically used for Link annotations.

Get an annotation's color.

Get an annotation's color.

Get an annotation's color.

Get the color space the annotation's color is represented in.

Get the annotation contents.

Returns custom data associated with the given key.

Gets an annotation's last modified date.

Determine if the give flag is marked flagged

Get optional content of an annotation.

Note: The return value is an (optional content) group or (optional content) membership dictionary (PDF::OCG::OCMD)specifying the optional content properties for the annotation. Before the annotation is drawn, its visibility shall be determined based on this entry as well as the annotation flags specified in the Flag entry . If it is determined to be invisible, the annotation shall be skipped, as if it were not in the document.

Get the page the annotation is associated with.

Get annoation bound rectangle

Get the rotation value of the annotation. The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90.

Note: This property is part of the appearance characteristics dictionary, this dictionary that shall be used in constructing a dynamic appearance stream specifying the annotation's visual presentation on the page.

Get the SDFObj.

Get the Action associated with the selected Annot Trigger event.

Get the annotation type.

Get the annotiation unique ID.

It is possible during viewing that GetRect does not return the most accurate bounding box of what is actually rendered. This method calculates the bounding box, rather than relying on what is specified in the PDF document. The bounding box is defined as the smallest rectangle that includes all the visible content on the annotation.

Checks if annoation is markup.

Checks if Annot is valid.

Regenerates the appearance stream for the annotation. This method can be used to auto-generate the annotation appearance after creating or modifying the annotation without providing an explicit appearance or setting the "NeedAppearances" flag in the AcroForm dictionary.

Note: If this annotation contains text, and has been added to a rotated page, the text in the annotation may be rotated. If RefreshAppearance is called *after* the annotation is added to a rotated page, then any text will be rotated in the opposite direction of the page rotation. If this method is called *before* the annotation is added to any rotated page, then no counter rotation will be applied. If you wish to call RefreshAppearance on an annotation already added to a rotated page, but you don't want the text to be rotated, you can do one of the following; temporarily un-rotate the page, or, temporarily remove the "Rotate" object from the annotation. To support users adding text annotations while using a PDF viewer, you can also add any viewer rotation to the annotations Rotate object, to have text always rotated correctly, from the users perspective.

A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.

Removes the annotation's default appearance.

Removes the annotation's appearance for the given combination of annotation and appearance states.

Resize annotation

Set the annotation's active appearance state. (Required if the appearance dictionary AP contains one or more subdictionaries; PDF'1.2)

Set the annotation's appearance for the given combination of annotation and appearance states. (Optional; PDF'1.2)

Set the annotation's appearance for the given combination of annotation and appearance states. (Optional; PDF'1.2)

Set the annotation's appearance for the given combination of annotation and appearance states. (Optional; PDF'1.2)

Set the border style for the annotation. Typically used for Link annotations.

Set an annotation's color.

Set an annotation's color.

Set annotation contents.

Sets the custom data associated with the specified key.

Sets an annotation's last modified date.

Sets an annotation's last modified date to the current time.

Set the value of given Flag.

Set optional content of an annotation. (Optional, PDF1.5).

Set the reference to a page the annotation is associated with. (Optional PDF'1.3; not used in FDF files)

Note: The parameter should be an indirect reference to the page object with which this annotation is associated. This entry shall be present in screen annotations associated with rendition actions

Set the size and location of an annotation on its page.

Set the rotation value of the annotation. The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. (Optional)

Note: This property is part of the appearance characteristics dictionary, this dictionary that shall be used in constructing a dynamic appearance stream specifying the annotation's visual presentation on the page.

Set the struct parent of an annotation. (Required if the annotation is a structural content item; PDF'1.3)

Note: The StructParent is the integer key of the annotation's entry in the structural parent tree.

Set the unique identifier for this annotation.

Note: It is necessary to ensure that the unique ID generated is actually unique.