ActivateInputField
Forms, interaction, input
Description
Internal helper of TPDFlibFormSession that performs the Widget activation step shared by pointer-up handling and keyboard activation in DispatchInputEvent
Text fields and editable choice fields with choice type 4 continue through
BeginEdit
Off, while other choice fields, pushbutton fields and signature fields report success without changing anything
Check box and radio activation resolves the first non-empty on-state that is not Yes from the Widget's own appearances or those of its base field, defaulting to
$4000
ValueChanged when none is found
An exact radio Widget switches its own appearance state while other Widgets write the base field value, and activating a radio that already holds the on-state clears it unless the base field flags contain the radio NoToggleToOff mask OnValueChanged
A committed check box or radio change is reported through
Declaration
function ActivateInputField(FieldIndex: Integer;
out ValueChanged: Boolean): Integer;
Parameters
| FieldIndex | Field or temporary Widget index to activate |
|---|---|
| ValueChanged | Receives True when the activation changed the stored field value |
Return value
Returns 1 when the activation was acknowledged or performed, otherwise 0 for an invalid or read-only Widget or a failed value write
See also
DispatchInputEvent, BeginEdit, FocusField, TPDFlibFormInputEvent, TPDFlibFormSessionValueEvent, TPDFlibFormSession