FormFieldWebLinkActionA
Form fields
Description
The trailing A denotes the ANSI (char) DLL entry point; the ActiveX/COM surface exposes only the Unicode form. Behaviour is identical to FormFieldWebLinkAction and string arguments are interpreted using the current SetAnsiMode code page
Adds an action to the specified form field that links to an internet address
Syntax
Delphi
Function DLFormFieldWebLinkActionA(InstanceID, Index: Integer; ActionType, Link: PAnsiChar): Integer;
DLL
int DLFormFieldWebLinkActionA(int InstanceID, int Index, const char * ActionType, const char * Link);
Parameters
| Index | The index of the form field to set the action of |
|---|---|
| ActionType | 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 |
| Link | The URL to link to. Some examples: "http://www.example.com" "mailto:info@example.com" |
Return values
| 0 | The form field could not be found, or the ActionType was invalid |
|---|---|
| 1 | The web link action was added to the form field successfully |