CancelEvent Method

Cancels behaviors that are triggered by the event that caused the current script to run. Corresponds to the CancelEvent action.

App.CancelEvent()

Newlook Smartclient

Newlook Server

None.

This method is intended to provide the user with a means to cancel certain behaviors that cannot be prevented any other way.

The CancelEvent method does not cancel the event itself. It is limited to specific scenarios that cannot be prevented any other way.

The CancelEvent method can be used with the following event-related properties:

OnSend property of a form - the current screen will not be sent to the host. This is useful if you wish to validate certain fields on the screen before sending the screen to the host.
OnClick property of a function key - if a script containing the CancelEvent method is called via the OnClick property of a function key, then the key specified in the OutputKey property will not be sent to the host.
OnOption property of a datagrid - the selected option will not be sent to host.
OnSelChanging of a tab control or smartNav control - the focus will not move to the selected tab or group.

If the script was not triggered by an event, this method does nothing.

This event returns a boolean, indicating if the method is successful or not.