 | AnnotationFlags Enumeration |
Namespace:
Patagames.Pdf.Enums
Assemblies:
Patagames.Pdf.Xamarin.iOS (in Patagames.Pdf.Xamarin.iOS.dll) Version: 4.84.2704
Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.84.2704
Syntax[FlagsAttribute]
public enum AnnotationFlags
<FlagsAttribute>
Public Enumeration AnnotationFlags
[FlagsAttribute]
public enum class AnnotationFlags
[<FlagsAttribute>]
type AnnotationFlags
/** @attribute FlagsAttribute */
public enum AnnotationFlags
Patagames.Pdf.Enums.AnnotationFlags = function();
Patagames.Pdf.Enums.AnnotationFlags.createEnum('Patagames.Pdf.Enums.AnnotationFlags', true);
Members
| Member name | Value | Description |
---|
| None | 0 |
No any flags are setted.
|
| Invisible | 1 |
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 unknown annotation using an appearance stream specified by its appearance dictionary, if any.
|
| Hidden | 2 |
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. 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.
|
| Print | 4 |
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 | 8 |
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 remarks for further discussion.
|
| NoRotate | 16 |
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. See remarks for further discussion.
|
| NoView | 32 |
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 the Print flag) but should be considered hidden for purposes of onscreen display and user interaction.
|
| ReadOnly | 64 |
If 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.
Note |
---|
This flag is ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field |
|
| Locked | 128 |
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 | 256 |
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 | 512 |
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.
|
Remarks
If the NoZoom flag is set, the annotation always maintains the same fixed size on
the screen and is unaffected by the magnification level at which the page itself is
displayed. Similarly, if the NoRotate flag is set, the annotation retains its original
orientation on the screen when the page is rotated.
In either case, the annotation’s position is determined by the coordinates of the
upper-left corner of its annotation rectangle, as defined by the Rect entry in the
annotation dictionary and interpreted in the default user space of the page.When
the default user space is scaled or rotated, the positions of the other three corners
of the annotation rectangle are different in the altered user space than they were
in the original user space.The viewer application performs this alteration automatically.
However, it does not actually change the annotation’s Rect entry, which
continues to describe the annotation’s relationship with the unscaled, unrotated
user space.
See Also