DynaPDF Manual - Page 387

Previous Page 386   Index   Next Page 388

Function Reference
Page 387 of 818
float
TextScaling;
// Text fields only
const char*
ToolTipA;
// Optional tool tip
const UI16*
ToolTipW;
// Optional tool tip
const char*
UniqueNameA;
// Optional unique name (NM key)
const UI16*
UniqueNameW;
// Optional unique name (NM key)
const char*
ValueA;
// Field value
const UI16*
ValueW;
// Field value
float
WordSpacing;
// Text fields only
const void*
IBarcode;
// If present, this field is a barcode
// field. The field type is set to
// ftText since barcode fields are
// extended text fields.
// GetBarcodeDict() returns the
// properties of the barcode.
const void*
ISignature;
// Present only for imported signature
// fields which which have a value. That
// means the file was digitally signed.
// GetSigDict() returns the signature
// dictionary. Signed signature fields
// are always marked as deleted!
const char*
ModDate;
// Last modification date (optional)
// Push buttons only. The down and roll over states are optional. If
// not present, then all states use the up state.
// The handles of the up, down, and roll over states are template
// handles! The templates can be opened for editing with
// EditTemplate2() and parsed with ParseContent().
TBtnCaptionPos CaptionPos;
// Where to position the caption
const char*
DownCaptionA;
// Caption of the down state
const UI16*
DownCaptionW;
// Caption of the down state
SI32
DownImage;
// Template handle of the down state
const char*
RollCaptionA;
// Caption of the roll over state
const UI16*
RollCaptionW;
// Caption of the roll over state
SI32
RollImage;
// Templ. handle of the roll over state
const char*
UpCaptionA;
// Caption of the up state
const UI16*
UpCaptionW;
// Caption of the up state
SI32
UpImage;
// Template handle of the up state
SI32
OC;
// Handle of an OCG or OCMD or -1
SI32
Action;
// Action handle or -1 if not set. This action is executed when
// the field is activated.
TActionType
ActionType;
// Meaningful only, if Action >= 0.
IEVT*
Events;
// See GetObjEvent() if set.
UI32
FmtTextColor;
// Zero if not set. Usually RGB red otherwise.
const char*
FmtTextA;
// Text fields only. The formatted field value if the field
// contains an OnFormat Javascript action.
const UI16*
FmtTextW;
// Note that either the Ansi or Unicode value is set.
};
typedef enum
{
bcpCaptionOnly,
// Default
bcpImageOnly,
// No caption; image only
bcpCaptionBelow, // Caption below the image
bcpCaptionAbove, // Caption above the image
bcpCaptionRight, // Caption on the right of the image
bcpCaptionLeft,
// Caption on the left of the image
bcpCaptionOver
// Caption overlaid directly on the image
}TBtnCaptionPos;
The function returns the most important properties of a field. The parameter Handle must be a valid
field handle. Field handles are simple array indexes into the field array of the global AcroForm
object. To enumerate all fields of a document execute the function in a loop from 0 though
GetFieldCount() -1.
The member StructSize must be initialized to sizeof(TPDFFieldEx) before calling the function.
 

Previous topic: GetFieldCount, GetFieldEx

Next topic: Radio Buttons, Formatted Text Field Value


Start Chat