Xojo Conferences
XDCMay2019MiamiUSA

DynaPDF Manual - Page 371

Previous Page 370   Index   Next Page 372

Function Reference
Page 371 of 766
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.
Return values:
If the function succeeds the return value is the field index, a value greater or equal zero. If the
function fails the return value is a negative error code.
 

Previous topic: GetFieldGroupType

Next topic: GetFieldName