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

DynaPDF Manual - Page 361

Previous Page 360   Index   Next Page 362

Function Reference
Page 361 of 750
GetFieldFlags
Syntax:
SI32 pdfGetFieldFlags(
const PPDF* IPDF, // Instance pointer
UI32 AField)
// Field handle
typedef UI32 TFieldFlags;
// Basic flags supported by all field types except group fields and
// radio button fields.
#define ffReadOnly
0x00000001
#define ffRequired
0x00000002
#define ffNoExport
0x00000004
#define ffInvisible
0x00000008
#define ffHidden
0x00000010
#define ffPrint
0x00000020
#define ffNoZoom
0x00000040
#define ffNoRotate
0x00000080
#define ffNoView
0x00000100
// Special flags supported by specific fields only
#define ffMultiline
0x00001000
#define ffPassword
0x00002000
#define ffNoToggleToOff
0x00004000
#define ffRadioIsUnion
0x04000000
#define ffCommitOnSelCh
0x08000000
#define ffEdit
0x00040000
#define ffSorted
0x00080000
#define ffFileSelect
0x00100000
#define ffMultiSelect
0x00200000
#define ffDoNotSpellCheck 0x00400000
#define ffDoNotScroll
0x00800000
#define ffComb
0x01000000
The function returns the flags of a specific interactive form field. The parameter AField must be a
valid handle of an interactive form field.
Interactive form fields and annotations support the same basic set of field flags because both object
types are in fact annotations. When we talk about form fields then we talk about an extended version
of annotations because form fields are annotations. However, to make the handling easier, form
fields and annotations are handled separately by DynaPDF.
The flags are described in detail on the next page.
Return values:
If the function succeeds the return value is a number greater or equal zero representing the flags
used by the field (this is a bit mask, to check whether a specific flag is set, use the bitwise and
operator). If the function fails the return value is a negative error code.
 

Previous topic: GetFieldExpValueEx

Next topic: GetFieldGroupType