AnnotationFlags

AnnotationFlags enumeration

A set of flags specifying various characteristics of the annotation.

Members

Member nameDescription
DEFAULTDefault value.
INVISIBLEIf 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.
HIDDENIf 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.
In cases where screen space is limited, the ability to hide and show annotations selectively
can be used in combination with appearance streams to display auxiliary pop-up information
similar in function to online help systems.
PRINTIf 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.
NO_ZOOMIf 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.
NO_ROTATEIf 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.
NO_VIEWIf 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.
READ_ONLYIf 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. This flag is ignored for widget annotations;
its function is subsumed by the ReadOnly flag of the associated form field.
LOCKEDIf 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.
TOGGLE_NO_VIEWIf 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.
LOCKED_CONTENTSIf 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.

See Also