PXC_AnnotFlag Enumeration
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:PXC_AnnotFlag Enumeration}} | {{#customTitle:PXC_AnnotFlag Enumeration}} | ||
| + | {{#parentPage:PXV:PXC_Enumerations|PXC_AnnotFlag|enum}} | ||
| − | + | ||
| + | Defines annotations flags. See PDF Reference for more information about annotations' flags. | ||
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">enum PXC_AnnotFlag | <pre class="brush:cpp;gutter:false">enum PXC_AnnotFlag | ||
{ | { | ||
| − | AF_Invisible = 1 | + | AF_Invisible = 1, |
| − | AF_Hidden = 2 | + | AF_Hidden = 2, |
| − | AF_Print = 4 | + | AF_Print = 4, |
| − | AF_NoZoom = 8 | + | AF_NoZoom = 8, |
| − | AF_NoRotate = 16 | + | AF_NoRotate = 16, |
| − | AF_NoView = 32 | + | AF_NoView = 32, |
| − | AF_ReadOnly = 64 | + | AF_ReadOnly = 64, |
| − | AF_Locked = 128 | + | AF_Locked = 128, |
| − | AF_ToggleNoView = 256 | + | AF_ToggleNoView = 256, |
| − | AF_ContentLocked = 512 | + | AF_ContentLocked = 512, |
}; | }; | ||
</pre> | </pre> | ||
| Line 22: | Line 25: | ||
== Constants == | == Constants == | ||
;AF_Invisible | ;AF_Invisible | ||
| − | : | + | :If set, the annotation will not be displayed if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, such an unknown annotation will be displayed using an appearance stream specified by its appearance dictionary, if any. |
;AF_Hidden | ;AF_Hidden | ||
| − | : | + | :If set, the annotation will not be displayed or printed or interact with the user, regardless of its annotation type or whether an annotation handler is available. |
;AF_Print | ;AF_Print | ||
| − | : | + | :If set, annotation will be printed when the page is printed. If clear, annotation will never be printed, regardless of whether it is displayed on the screen. |
;AF_NoZoom | ;AF_NoZoom | ||
| − | : | + | :If set, annotation's appearance will not be be scaled to match the magnification of the page. |
;AF_NoRotate | ;AF_NoRotate | ||
| − | :The | + | :If set, annotation's appearance will not be rotated to match the rotation of the page. The upper-left corner of the annotation rectangle will remain in a fixed location on the page, regardless of the page rotation. |
;AF_NoView | ;AF_NoView | ||
| − | :The | + | :If set, the annotation will not be displayed on the screen and will not interact with the user. The annotation may be printed (depending on the setting of the <tt>AF_Print</tt> flag) but will be considered hidden for purposes of on-screen display and user interaction. |
;AF_ReadOnly | ;AF_ReadOnly | ||
| − | : | + | :If set, the annotation will not interact with the user. The annotation may be displayed or printed (depending on the settings of the <tt>AF_NoView</tt> and <tt>AF_Print</tt> flags) but will not respond to mouse clicks or change its appearance in response to mouse motions. This flag ignored for widget annotations; its function is subsumed by the <tt>FF_ReadOnly</tt> flag of the associated [[PXV:IPXC_FormField|form field]]. |
;AF_Locked | ;AF_Locked | ||
| − | : | + | :If set, the annotation is not allowed 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. |
;AF_ToggleNoView | ;AF_ToggleNoView | ||
| − | : | + | :If set, inverts the interpretation of the <tt>AF_NoView</tt> flag for certain events. |
;AF_ContentLocked | ;AF_ContentLocked | ||
| − | : | + | :If set, the annotation's contents is not allowed 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. |
| − | + | ||
| − | + | ||
| − | + | ||
Latest revision as of 14:59, 7 September 2015
Defines annotations flags. See PDF Reference for more information about annotations' flags.
Syntax
enum PXC_AnnotFlag
{
AF_Invisible = 1,
AF_Hidden = 2,
AF_Print = 4,
AF_NoZoom = 8,
AF_NoRotate = 16,
AF_NoView = 32,
AF_ReadOnly = 64,
AF_Locked = 128,
AF_ToggleNoView = 256,
AF_ContentLocked = 512,
};
Constants
- AF_Invisible
- If set, the annotation will not be displayed if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, such an unknown annotation will be displayed using an appearance stream specified by its appearance dictionary, if any.
- AF_Hidden
- If set, the annotation will not be displayed or printed or interact with the user, regardless of its annotation type or whether an annotation handler is available.
- AF_Print
- If set, annotation will be printed when the page is printed. If clear, annotation will never be printed, regardless of whether it is displayed on the screen.
- AF_NoZoom
- If set, annotation's appearance will not be be scaled to match the magnification of the page.
- AF_NoRotate
- If set, annotation's appearance will not be rotated to match the rotation of the page. The upper-left corner of the annotation rectangle will remain in a fixed location on the page, regardless of the page rotation.
- AF_NoView
- If set, the annotation will not be displayed on the screen and will not interact with the user. The annotation may be printed (depending on the setting of the AF_Print flag) but will be considered hidden for purposes of on-screen display and user interaction.
- AF_ReadOnly
- If set, the annotation will not interact with the user. The annotation may be displayed or printed (depending on the settings of the AF_NoView and AF_Print flags) but will not respond to mouse clicks or change its appearance in response to mouse motions. This flag ignored for widget annotations; its function is subsumed by the FF_ReadOnly flag of the associated form field.
- AF_Locked
- If set, the annotation is not allowed 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.
- AF_ToggleNoView
- If set, inverts the interpretation of the AF_NoView flag for certain events.
- AF_ContentLocked
- If set, the annotation's contents is not allowed 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.
