DynaPDF Manual - Page 380

Previous Page 379   Index   Next Page 381

Function Reference
Page 380 of 787
However, a set of fields with identical names are internally stored in a group field. The group type
specifies the field type of the group, e.g. ftText if text fields are stored in the group. A field group
cannot contain different field types. An indication whether a field is a child of a field group is an
empty field name because the field name is taken from the parent group field in this case. Radio
buttons are identically organized, but the field type is ftRadioBtn in this case.
Return values:
If the function succeeds the return value is the field group type that is a value greater or equal zero.
Make a type cast to TFieldType in this case. If the function fails the return value is a negative error
code.
GetFieldHighlightMode
Syntax:
SI32 pdfGetFieldHighlightMode(
const PPDF* IPDF, // Instance pointer
UI32 AField)
// Field handle
typedef enum
{
hmNone
= 0,
hmInvert
= 1,
hmOutline
= 2,
hmPush
= 3,
hmPushUpd
= 4
// Update appearance stream on changes
}THighlightMode;
The function returns the highlight mode of buttons, checkboxes, and signature fields. All other field
types have no property highlight mode, the function returns hmNone in this case.
Return values:
If the function succeeds the return value is the highlight mode, a value greater or equal zero. Make a
type cast to THighlightMode in this case. If the function fails the return value is a negative error
code.
GetFieldIndex
Syntax:
SI32 pdfGetFieldIndex(
const PPDF* IPDF, // Instance pointer
UI32 AField)
// Field handle
The function returns the page index or tab order of the field. The index of newly created fields starts
at 1000. This makes it easier to set a field to another position inside the tab order. The field index can
be changed with the function SetFieldIndex(). Note that fields must be sorted by index with the
function SortFieldsByIndex(). Fields must be sorted for each page separately.
 

Previous topic: GetFieldGroupType

Next topic: GetFieldMapName, GetFieldName

Start Chat