| FoxitPDFSDKforWeb v11.0.6 Archives Foxit PDF SDK for Web

Enumerations
constant
PDF » annots

## Enumerations
enum | Annot_Flags { invisible = 1, hidden = 2, print = 4, noZoom = 8, noRotate = 16, noView = 32, readOnly = 64, locked = 128, toggleNoView = 256, lockedContents = 512 }
| Enumeration for PDF annotation flags. More...
enum | Annot_Type { unKnownType ="unknowntype", text ="text", link ="link", freeText ="freetext", line ="line", square ="square", circle ="circle", polygon ="polygon" , polyline ="polyline", highlight ="highlight", underline ="underline", squiggly ="squiggly", strikeOut ="strikeout", stamp ="stamp", caret ="caret", ink ="ink", psInk ="psink", fileAttachment ="fileattachment" , widget ="widget", screen ="screen" , popup ="popup", redact ="redact" }
| Enumeration for PDF annotation type. More...
enum | Annot_Unit_Type { inch = "inch", custom = "custom", mi = "mi", pt = "pt", ft = "ft", yd = "yd", km = "km", m = "m", cm = "cm", mm = "mm", pica = 'pica' }
| Enumeration for PDF annotation unit type. More...
enum | MARKUP_ANNOTATION_STATE { MARKED = 'marked', UNMARKED = 'unmarked', ACCEPTED = 'accepted', REJECTED = 'rejected', CANCELLED = 'cancelled', COMPLETED = 'completed', DEFERRED = 'deferred', FUTURE = 'future', NONE = 'none' }
| Enumeration for markup annotation review/mark state. More...

## Detailed Description

Annot related constants

## Enumeration Type Documentation

## ◆ Annot_Flags

enum Annot_Flags

Enumeration for PDF annotation flags.

Enumerator
invisible | Annotation flag: invisible. If 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 non-standard annotation using an appearance stream specified by its appearance dictionary, if any.
hidden | Annotation flag: hidden. If 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.
print | Annotation flag: print. If 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.
noZoom | Annotation flag: no zoom. If set, do not scale the annotation's appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification. See below for further discussion.
noRotate | Annotation flag: no rotate. If set, do not rotate the annotation's appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation.
noView | Annotation flag: no view. If 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 flag ANNOT_FLAGS::print) but should be considered hidden for purposes of on-screen display and user interaction.
readOnly | Annotation flag: read only. If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of flags ANNOT_FLAGS::noView and ANNOT_FLAGS::print) but should not respond to mouse clicks or change its appearance in response to mouse motions. This flag is ignored for widget annotations; its function is subsumed by flag interform::ANNOT_FLAGS::readOnly of related form field.
locked | Annotation flag: locked. If 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.
toggleNoView | Annotation flag: toggle no view. If 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.
lockedContents | Annotation flag: locked contents. If 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.

## ◆ Annot_Type

enum Annot_Type

Enumeration for PDF annotation type.

Enumerator
unKnownType | Annotation type: unknown.
text | Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PDF reference 1.7>.
link | Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
freeText | Annotation type: free text annotation. One of standard annotation in <PDF reference 1.7>.
line | Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
square | Annotation type: square annotation. One of standard annotation in <PDF reference 1.7>.
circle | Annotation type: circle annotation. One of standard annotation in <PDF reference 1.7>.
polygon | Annotation type: polygon annotation. One of standard annotation in <PDF reference 1.7>.
polyline | Annotation type: polyline annotation. One of standard annotation in <PDF reference 1.7>.
highlight | Annotation type: highlight annotation. One of standard annotation in <PDF reference 1.7>.
underline | Annotation type: underline annotation. One of standard annotation in <PDF reference 1.7>.
squiggly | Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1.7>.
strikeOut | Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1.7>.
stamp | Annotation type: stamp annotation. One of standard annotation in <PDF reference 1.7>.
caret | Annotation type: caret annotation. One of standard annotation in <PDF reference 1.7>.
ink | Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
psInk | Annotation type: pressure sensitive ink annotation.
fileAttachment | Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1.7>.
widget | Annotation type: widget annotation. One of standard annotation in <PDF reference 1.7>. Foxit PDF SDK treats widget annotation as form control.
screen | Annotation type: screen annotation. One of standard annotation in <PDF reference 1.7>.
popup | Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1.7>.
redact | Annotation type: redact annotation.

## ◆ Annot_Unit_Type

enum Annot_Unit_Type

Enumeration for PDF annotation unit type.

Since
  8.0.0

Enumerator
inch | unit type: inch.
custom | unit type: custom.
mi | unit type: mile.
pt | unit type: point.
ft | unit type: foot.
yd | unit type: yard.
km | unit type: kilometer.
m | unit type: meter.
cm | unit type: centimeter.
mm | unit type: millimeter.
pica | unit type: pica.

## ◆ MARKUP_ANNOTATION_STATE

enum MARKUP_ANNOTATION_STATE

Enumeration for markup annotation review/mark state.

Enumerator
MARKED | An annotation has been marked by user. See also Markup.addMarkedState
UNMARKED | An annotation has not been marked by any user. See also Markup.addMarkedState
ACCEPTED | User agrees with the change. See also Markup.addReviewState
REJECTED | User disagrees with the change. See also Markup.addReviewState
CANCELLED | The change has been cancelled. See also Markup.addReviewState
COMPLETED | The change has been completed. See also Markup.addReviewState
DEFERRED | The change has been deferred.
FUTURE | The change will be working in the future.
NONE | The user has indicated nothing about the change. See also Markup.addReviewState

@2025 Foxit Software Incorporated. All rights reserved.