FormFieldWebLinkAction

Form fields

Description

Adds an action to the specified form field that links to an internet address.

Syntax

Delphi

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

ActiveX

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

DLL

int DLFormFieldWebLinkAction(int InstanceID, int Index, wchar_t * ActionType, wchar_t * Link);

Parameters

IndexThe index of the form field to set the action of
ActionTypeThe 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
LinkThe URL to link to. Some examples: "http://www.example.com" "mailto:info@example.com"

Return values

0The form field could not be found, or the ActionType was invalid
1The web link action was added to the form field successfully