LayerAcrobat_Forms_Layer
ObjectGeneral

General Acrobat Forms layer objects.



Define Summary
 Define
 AllFieldMask_F
 AutoSize
 CanonicalFormat_F
 CB_AcroForm
 CB_AFPDFieldFlags_t
 CB_PDField
 CB_RetCode
 CenterQ
 Clear_F
 Comb_F
 CommitOnSelChange_F
 Editable_F
 EmbedForm_F
 ExclFKey_F
 ExclNonUserAnnots_F
 FileSelect_F
 InclAnnotations_F
 InclAppendSaves_F
 InclEmpty_F
 InclNMKey_F
 InclOrExcl_F
 include
 LeftQ
 MultiLine_F
 MultipleSelection_F
 name
 NameSeparator
 NameSeparatorStr
 NoExport_F
 OptionsSorted_F
 ParDirectionRTL_F
 Password_F
 PDField
A PDField is an opaque object representing a field in an Acrobat form. The three most important properties of a field are its type, name, and value. Other properties specify the appearance of a field. Fields can be organized into a hierarchy, and other field properties associate it with its parent and children.
 PopUp_F
 Push_F
 Radio_F
 RadiosInUnison_F
 Required_F
 RichText_F
 RightQ
 StayPushed_F
 SubmitCoords_F
 SubmitPDF_F
 UrlEnc_F
 URL_Enc_F
 XDP_Enc_F
 XFD_Enc_F
 XFDF_Enc_F
 XML_Enc_F
Typedef Summary
 Typedef
 ActionFlags_t
 CAgg_P
 CPDField_P
 CWidget_P
 EConstStr
 EStr
 ScriptingData
Enumeration Summary
 Enumeration
  anonAF_Sel24
  anonAFTTS_Sel22
  RetCode
Method Summary
 Method
 
typedef void(ACCB2 AFTTSNotifyProc)
Notification callback for TTS routines.
Defines Detail
AllFieldMask_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AllFieldMask_F ((AFPDFieldFlags_t)0x00000FFF)

File: AF_ExpT.h
Line: 153
AutoSize 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AutoSize fixedZero

File: AF_ExpT.h
Line: 361
CanonicalFormat_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CanonicalFormat_F ((ActionFlags_t)0x0200)

File: AF_ExpT.h
Line: 590
CB_AcroForm 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CB_AcroForm AcroCallback(AcroForm)

File: AF_ExpT.h
Line: 67
CB_AFPDFieldFlags_t 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CB_AFPDFieldFlags_t AcroCallback(AFPDFieldFlags_t)

File: AF_ExpT.h
Line: 145
CB_PDField 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CB_PDField AcroCallback(PDField)

File: AF_ExpT.h
Line: 95
CB_RetCode 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CB_RetCode AcroCallback(RetCode)

File: AF_ExpT.h
Line: 54
CenterQ 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CenterQ (ASUns16)1

File: AF_ExpT.h
Line: 260
Clear_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Clear_F ((AFPDFieldFlags_t)0x00000000)

File: AF_ExpT.h
Line: 147
Comb_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Comb_F ((AFPDFieldFlags_t)0x01000000)

File: AF_ExpT.h
Line: 170
CommitOnSelChange_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CommitOnSelChange_F ((AFPDFieldFlags_t)0x04000000)

File: AF_ExpT.h
Line: 188
Editable_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Editable_F ((AFPDFieldFlags_t)0x00040000)

File: AF_ExpT.h
Line: 185
EmbedForm_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define EmbedForm_F ((ActionFlags_t)0x2000)

File: AF_ExpT.h
Line: 594
ExclFKey_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ExclFKey_F ((ActionFlags_t)0x0800)

File: AF_ExpT.h
Line: 592
ExclNonUserAnnots_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ExclNonUserAnnots_F ((ActionFlags_t)0x0400)

File: AF_ExpT.h
Line: 591
FileSelect_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define FileSelect_F ((AFPDFieldFlags_t)0x00100000)

File: AF_ExpT.h
Line: 167
InclAnnotations_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define InclAnnotations_F ((ActionFlags_t)0x0080)

File: AF_ExpT.h
Line: 588
InclAppendSaves_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define InclAppendSaves_F ((ActionFlags_t)0x0040)

File: AF_ExpT.h
Line: 587
InclEmpty_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define InclEmpty_F ((ActionFlags_t)0x0002)

File: AF_ExpT.h
Line: 582
InclNMKey_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define InclNMKey_F ((ActionFlags_t)0x4000)

File: AF_ExpT.h
Line: 595
InclOrExcl_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define InclOrExcl_F ((ActionFlags_t)0x0001)

File: AF_ExpT.h
Line: 581
include 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define include h"

File: AF_Sel.h
Line: 48
LeftQ 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define LeftQ (ASUns16)0

File: AF_ExpT.h
Line: 259
MultiLine_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define MultiLine_F ((AFPDFieldFlags_t)0x00001000)

File: AF_ExpT.h
Line: 165
MultipleSelection_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define MultipleSelection_F ((AFPDFieldFlags_t)0x00200000)

File: AF_ExpT.h
Line: 187
name 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define name ##_SEL,

File: AF_Sel.h
Line: 29
NameSeparator 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define NameSeparator '

File: AF_ExpT.h
Line: 60
NameSeparatorStr 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define NameSeparatorStr "

File: AF_ExpT.h
Line: 61
NoExport_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define NoExport_F ((AFPDFieldFlags_t)0x00000004)

File: AF_ExpT.h
Line: 157
OptionsSorted_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define OptionsSorted_F ((AFPDFieldFlags_t)0x00080000)

File: AF_ExpT.h
Line: 186
ParDirectionRTL_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ParDirectionRTL_F ((AFPDFieldFlags_t)0x10000000)

File: AF_ExpT.h
Line: 192
Password_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Password_F ((AFPDFieldFlags_t)0x00002000)

File: AF_ExpT.h
Line: 166
PDField 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDField CPDField_P

Description

A PDField is an opaque object representing a field in an Acrobat form. The three most important properties of a field are its type, name, and value. Other properties specify the appearance of a field. Fields can be organized into a hierarchy, and other field properties associate it with its parent and children.

There is a field dictionary for every PDField. Acrobat uses annotations to represent a field's appearance and to manage user interactions. A PDField dictionary may also be an annotation, in which case its subtype is Widget. There is no ambiguity, because the keys of annotations and PDField objects do not overlap.

PDField objects are not created until needed. This saves memory and enhances performance.

Suppose, for example, a PDF file represents a 100-page catalog, where a purchase order is on the last page. PDField objects are not created for all the elements in the purchase order when the document is opened. When the user displays the purchase order, the annotation handler draws the field announcements and creates the PDField objects for form fields.

When the annotation handler creates a PDField, it typically displays a page that contains the field.


File: AF_ExpT.h
Line: 94
PopUp_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PopUp_F ((AFPDFieldFlags_t)0x00020000)

File: AF_ExpT.h
Line: 184
Push_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Push_F ((AFPDFieldFlags_t)0x00010000)

File: AF_ExpT.h
Line: 176
Radio_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Radio_F ((AFPDFieldFlags_t)0x00008000)

File: AF_ExpT.h
Line: 175
RadiosInUnison_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define RadiosInUnison_F ((AFPDFieldFlags_t)0x02000000)

File: AF_ExpT.h
Line: 181
Required_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Required_F ((AFPDFieldFlags_t)0x00000002)

File: AF_ExpT.h
Line: 156
RichText_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define RichText_F ((AFPDFieldFlags_t)0x02000000)

File: AF_ExpT.h
Line: 171
RightQ 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define RightQ (ASUns16)2

File: AF_ExpT.h
Line: 261
StayPushed_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define StayPushed_F ((AFPDFieldFlags_t)0x00004000)

File: AF_ExpT.h
Line: 174
SubmitCoords_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SubmitCoords_F ((ActionFlags_t)0x0010)

File: AF_ExpT.h
Line: 585
SubmitPDF_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SubmitPDF_F ((ActionFlags_t)0x0100)

File: AF_ExpT.h
Line: 589
URL_Enc_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define URL_Enc_F ((ActionFlags_t)0x20000)

File: AF_ExpT.h
Line: 598
UrlEnc_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define UrlEnc_F ((ActionFlags_t)0x0004)

File: AF_ExpT.h
Line: 583
XDP_Enc_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define XDP_Enc_F ((ActionFlags_t)0x1000)

File: AF_ExpT.h
Line: 593
XFD_Enc_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define XFD_Enc_F ((ActionFlags_t)0x10000)

File: AF_ExpT.h
Line: 597
XFDF_Enc_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define XFDF_Enc_F ((ActionFlags_t)0x0020)

File: AF_ExpT.h
Line: 586
XML_Enc_F 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

#define XML_Enc_F ((ActionFlags_t)0x8000)

File: AF_ExpT.h
Line: 596

Typedefs Detail
ActionFlags_t 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 ActionFlags_t;

File: AF_ExpT.h
Line: 581
CAgg_P 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct CAgg* CAgg_P;

File: AF_ExpT.h
Line: 47
CPDField_P 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct CPDField* CPDField_P;

File: AF_ExpT.h
Line: 45
CWidget_P 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct CWidget* CWidget_P;

File: AF_ExpT.h
Line: 46
EConstStr 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _EStrRec* EConstStr;

File: AF_ExpT.h
Line: 404
EStr 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _EStrRec* EStr;

File: AF_ExpT.h
Line: 403
ScriptingData 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void* ScriptingData;

File: AF_ExpT.h
Line: 685

Enumeration Detail
anonAF_Sel24
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum anonAF_Sel24 {
 AcroFormFirst_SEL = 0,
 
 AcroFormLast_SEL = (PDDoc doc)(PDDoc doc)(PDDoc doc, ASBool terminals, ASBool parameterIgnored, AFPDFieldEnumProc proc, void *clientData)(PDDoc doc, char* name)(CosObj dict)(PDField fldP)(PDField fldP)(PDField fldP)(PDField fldP)(PDField fldP, AF_Flags_t flagType)(PDField fldP)(PDField fldP)(PDField fldP, CosObj val)(PDField fldP, AF_Flags_t flagType, AFPDFieldFlags_t flags)(PDField fldP, CosObj array)(PDField fldP)(PDDoc pdForm, CosObj rgIncExcFlds, ASBool bIncl, ASBool bEmpty, ASBool bMenu, ASBool bLoadFields, ASPathName fdfPath)(PDDoc pdForm, CosObj rgIncExcFlds, ASBool bIncl, ASBool bEmpty, ASFile Hfile)(PDDoc pdForm, CosDoc cdFDF)(PDDoc pdForm, CosObj rgIncExcFlds, ASBool bIncl)(AF_NotificationSelector_t notificationID, AF_NotificationProc notifyProc, AF_NotificationFailureProc notifyFailure, void *clientData)(AF_NotificationSelector_t notificationID, ASInt32 observerID)(void** pcx, void** pobj)(PDDoc pdForm, CosObj rgIncExcFlds, ASBool bIncl, ASBool bEmpty, ASBool bMenu, ASBool bLoadFields, ASPathName fdfPath, const char* submitBtnName)(PDDoc pdForm, CosObj rgIncExcFlds, ASBool bIncl, ASBool bEmpty, ASFile Hfile, const char* submitBtnName)(PDDoc pdCurrForm, CosDoc cdFDF, ASBool bAddToCurr)(ExportAsFDFParams params)(CosDoc cd, PDPage pdp)(void* vlayout)(void* vlayout, AFPDWidgetBorder border, PDColorValue pdcvBrdr, PDColorValue pdcvBg,ASBool bDown)(void* vlayout, ASBool bMultline, ASBool bWrap, AFPDWidgetBorder border, TextAppearanceP ta, char* cBytes)(PDDoc pdd, PDField fldP)(PDAnnot pdan)(PDField fldP, TextAppearanceP aP)(PDField fldP, TextAppearanceP aP)(PDAnnot pdan, AFPDWidgetBorder pdwb)(PDAnnot pdan, AFPDWidgetBorder pdwb)(PDAnnot pdan, PDColorValue borderP, PDColorValue bkgndP)(PDAnnot pdan, PDColorValue borderP, PDColorValue bkgndP)(CosDoc cd, CosObj *coIcon, AVDoc avd, char *cTitle)(void* vlayout, ASBool bMultline, ASBool bWrap, AFPDWidgetBorder border, TextAppearanceP ta, char* cBytes, ASFixed fxMinFontSize, ASFixed fxMaxFontSize)(void* vLayout, AFPDWidgetPosition nPosition, CosObj coIcon, AFPDWidgetBorder border, TextAppearanceP ta, char *cBytes)(ScriptingData data)(PDDoc pdd, const char* cScript, char** pRetValue)(ASFixedRectP frBbox, PDRotate annotRotation, CosDoc cd)(void* vlayout)(PDDoc pdd, ASCab asc)(CosDoc cd, ASFixedRectP frBbox, PDRotate annotRotation, ASBool bWrap, AFPDWidgetBorder border, AFTextAttributesP textAttrs, ASConstText asText, ASFixed fxMinFontSize, ASFixed fxMaxFontSize)(PDField fldP, TextAppearanceP aP, size_t size)(PDField fldP, TextAppearanceP aP, size_t size)(ASAtom fieldType, ASFixedPoint *asfp)
}

File: AF_Sel.h
Line: 31

anonAFTTS_Sel22 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum anonAFTTS_Sel22 {
 AcroTTSFirst_SEL = 0,
 
 AcroTTSLast_SEL = (void)(const char* textdata, ASBool UseDefaultSpeaker)(void)(const char* soundName)(ASUns32 frequency, ASUns32 duration)(ASUns32 duration)(void)(void)(void)(void)(ASInt32 index)(void)(void)(void)(void)(void)(void)(void)(void)(const char* voiceName)(const char* punctuations)(ASUns32 speed)(ASUns32 chrScale)(ASUns32 volume)(ASUns32 pitch)(AFTTSNotifyProc proc)
}

File: AFTTS_Sel.h
Line: 35

RetCode 
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

enum RetCode {
 Good = 0,
 
 Bad,
 
 Failed,
 
 GoodKeepFDF
}

File: AF_ExpT.h
Line: 53



Method Detail
void()
Product availability: Acrobat, Reader
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void(ACCB2 AFTTSNotifyProc)

Notification callback for TTS routines.

Parameters

AFTTSNotifyProc

Returns

See Also


File: AFTTS_Sel.h
Line: 28