Feedback Edit

getEventArgs (Client API reference)

  • Article
  • 2 minutes to read

Returns an object with methods to manage the events.

Syntax

ExecutionContextObj.getEventArgs()

Return value

Type: Object

Description: See the below table for the object type information:

Events Return Object
OnChange None
OnDataLoad When the form OnDataLoad event occurs, you can use the getEventArgs method of the execution context object to retrieve an object that contains the following method:
getDataLoadState: Gets the state of the data load. It returns an enum with the following values:
- InitialLoad =1
- Save = 2
- Refresh = 3
OnGridDataLoad None
OnLoad When the form OnLoad event occurs, you can use the getEventArgs method of the execution context object to retrieve an object that contains the following method:
getDataLoadState: Gets the state of the data load. It returns an enum with the following values:
- InitialLoad =1
- Save = 2
- Refresh = 3
OnLookupTagClick When the form OnLookupTagClick event occurs, you can use the getEventArgs method of the execution context object to retrieve an object that contains the following methods:
- getTagValue: Gets the selected tag value. The value returned for the getTagValue method is a LookupValue.
- preventDefault
- isDefaultPrevented
OnPostSearch None
OnProcessStatusChange When the form OnProcessStatusChange event occurs, you can use the getEventArgs method of the execution context object to retrieve an object that contains the following methods:
- getStage: Gets the stage object corresponding to the event triggered. Returns the selected stage in for the OnStageSelected event and next or previous stage objects for the OnStageChange event depending on direction moved. More information: Stage methods.
- getDirection: Gets the direction of the stage advance action. It returns a string value Next or Previous.
OnReadyStateComplete None
OnRecordSelect None
OnResultOpened None
OnSave When the form OnSave event occurs, you can use the getEventArgs method of the execution context object to retrieve an object that contains the following methods:
- getSaveMode
- preventDefault
- isDefaultPrevented
OnSelection None
OnStageChange When the form OnStageChange event occurs, you can use the getEventArgs method of the execution context object to retrieve an object that contains the following methods:
- getStage: Gets the stage object corresponding to the event triggered. Returns the selected stage in for the OnStageSelected event and next or previous stage objects for the OnStageChange event depending on direction moved.More information: Stage methods.
- getDirection: Gets the direction of the stage advance action. It returns a string value Next or Previous.
OnStageSelected When the form OnStageSelected event occurs, you can use the getEventArgs method of the execution context object to retrieve an object that contains the following methods:
- getStage: Gets the stage object corresponding to the event triggered. Returns the selected stage in for the OnStageSelected event and next or previous stage objects for the OnStageChange event depending on direction moved. More information: Stage methods.
- getDirection: Gets the direction of the stage advance action. It returns a string value Next or Previous.
OnTabStateChange None
PreSearch None

Execution context