SetFormFieldSubmitActionEx

Form fields

Description

Adds a submit action to a button form field with a flags parameter for setting various submit options. Please refer to section "Form Actions" of the official PDF Specifications.

Syntax

Delphi

function TPDFlib.SetFormFieldSubmitActionEx(Index: Integer; Const ActionType, Link: WideString; Flags: Integer): Integer;

ActiveX

Function PDFlib::SetFormFieldSubmitActionEx(Index As Long, ActionType As String, Link As String, Flags As Long) As Long

DLL

int DLSetFormFieldSubmitActionEx(int InstanceID, int Index, wchar_t * ActionType, wchar_t * Link, int Flags);

Parameters

Index	The index of the form field The action type: E = An action to be performed when the cursor enters the annotation's active area X = An action to be performed when the cursor exits the annotation's active area D = An action to be performed when the mouse button is pressed inside the annotation's active area U = An action to be performed when the mouse button is released inside the annotation's active area Fo = An action to be performed when the annotation receives the input focus Bl = An action to be performed when the annotation loses the input focus (blurred) K = An action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box. This allows the keystroke to be checked for validity and rejected or modified. F = An action to be performed before the field is formatted to display its current value. This allows the field's value to be modified before formatting. V = An action to be performed when the field's value is changed. This allows the new value to be checked for validity. C = An action to be performed in order to recalculate the value of this field when that of another field changes
ActionType
Link	The URL of the server script that will process the form submission.
Flags	Adobe defined flags value for the formfield submit action.

Return values

0	Could not set the field action
1	Success