Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

DynaPDF Manual - Page 602

Previous Page 601   Index   Next Page 603

Function Reference
Page 602 of 750
SetAnnotFlags
Syntax:
LBOOL pdfSetAnnotFlags(
const PPDF* IPDF,
// Instance pointer
TAnnotFlags Flags) // Flags see below
typedef UI32 TAnnotFlags;
#define afNone
0x00000000 // No flags are set
#define afInvisible
0x00000001 // see below
#define afHidden
0x00000002 // see below
#define afPrint
0x00000004 // Annotation is printable
#define afNoZoom
0x00000008 // Do not zoom the annotation
#define afNoRotate
0x00000010 // Do not rotate the annotation
#define afNoView
0x00000020 // See description below
#define afReadOnly
0x00000040 // Changes are not allowed
#define afLocked
0x00000080 // See description below
#define afToggleNoView
0x00000100 // See description below
#define afLockedContents 0x00000200 // See description below
The function sets the default flags used for new annotations. The parameter Flags is a bit mask;
multiple flags can be set with a binary or operator (e.g. afPrint | afReadOnly). It is also possible to
add each flag separately; the previous flags are only deleted if afNone is used.
pdfSetAnnotFlags(pdf, afPrint | afReadOnly);
// or set each flag separately, the result is the same
pdfSetAnnotFlags(pdf, afPrint);
pdfSetAnnotFlags(pdf, afReadOnly);
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
Flag
Description
afNone
No flags are set.
afInvisible
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.
afHidden
(PDF 1.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.
afPrint
(PDF 1.2) 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.
 

Previous topic: SetAnnotColor

Next topic: SetAnnotFlagsEx