GetFormFieldActionID

Form fields, Annotations and hotspot links

Description

Returns an ActionID for the specified form field which can be used with the various action manipulation functions such as GetActionType, GetActionDest, GetActionURL and SetActionURL.

There are different trigger events and each one has it's own action.

Syntax

Delphi

function TPDFlib.GetFormFieldActionID(Index: Integer; Const TriggerEvent: WideString): Integer;

ActiveX

Function PDFlib::GetFormFieldActionID(Index As Long, TriggerEvent As String) As Long

DLL

int DLGetFormFieldActionID(int InstanceID, int Index, wchar_t * TriggerEvent);

Parameters

Index	The index of the form field to work with. The first form field has an index of 1.
TriggerEvent	Retrieve the action for the specified trigger event: Empty string = simple activation action E = annotation enter action X = annotation exit action D = annotation button down action U = annotation button up action Fo = annotation input focus action Bl = annotation input blur (opposite of focus) action PO = annotation page open action PC = annotation page close action PV = annotation page visible action PI = annotation page invisible action K = form field change action F = form field format action V = form field validate action C = form field calculate action

Index

The index of the form field to work with. The first form field has an index of 1.

TriggerEvent

Retrieve the action for the specified trigger event: Empty string = simple activation action E = annotation enter action X = annotation exit action D = annotation button down action U = annotation button up action Fo = annotation input focus action Bl = annotation input blur (opposite of focus) action PO = annotation page open action PC = annotation page close action PV = annotation page visible action PI = annotation page invisible action K = form field change action F = form field format action V = form field validate action C = form field calculate action

Return values

0	The field index was invalid or the field does not have an action associated with the specified trigger event
Non-zero	The form field's ActionID for the specified trigger event