getEventArgs (Client API reference)
Returns an object with methods to manage the events.
Syntax
ExecutionContextObj.getEventArgs()
Return value
Type: Object
Description: When a specified event occurs, you can use the getEventArgs method of the execution context object to retrieve an object that may contain additional methods you can use. The table below describes the methods:
| Events | Return Object Methods |
|---|---|
| OnChange | None |
| OnDataLoad | 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 | getDataLoadState: Gets the state of the data load. It returns an enum with the following values:- InitialLoad =1 - Save = 2 - Refresh = 3 |
| OnLookupTagClick | - getTagValue: Gets the selected tag value. The value returned for the getTagValue method is a LookupValue.- preventDefault: Cancels the save operation, but all remaining handlers for the event will still be executed. - isDefaultPrevented: Returns a value indicating whether the save event has been canceled because the preventDefault method was used in this event handler or a previous event handler. |
| OnPostSearch | None |
| OnPostSave Event | - getEntityReference: Returns a lookup value that references the record. - getIsSaveSuccess: Returns data about whether the save operation succeeded. - getSaveErrorInfo: If the save operation failed, returns data about why it failed. |
| OnProcessStatusChange | - getStatus: Returns the Business Process Flow status: Active, Finished, or Aborted. |
| OnPreProcessStatusChange | - getStatus: Returns the Business Process Flow status: Active, Finished, or Aborted. |
| OnPreStageChange event | - 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. |
| OnReadyStateComplete | None |
| OnRecordSelect | None |
| OnResultOpened | None |
| OnSave | - getSaveMode: Returns a value indicating how the save event was initiated by the user. - preventDefault: Cancels the save operation, but all remaining handlers for the event will still be executed. - isDefaultPrevented: Returns a value indicating whether the save event has been canceled because the preventDefault method was used in this event handler or a previous event handler. If the event is async and async handlers are enabled, the following are also available: - preventDefaultOnError: Cancels the save operation if the event handler has a script error. - disableAsyncTimeout: Disables the default async handler timeout. |
| OnSelection | None |
| OnStageChange | - 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 | - 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 |