OverviewInterfaceSpecial FeaturesEvents
Each event represents something that can happen at run time. When an event is triggered, any actions that were added to it will be performed. The following describes all of the possible events that may be fired from a screen. You can find these events on the Actions tab of each screen's properties dialog.
Note: Some events contain special event variables that are local to the event and contain more information about the event.
Note: Some events will already contain action script and should not be modified unless you want to customize the default behavior of the screen.
This event is fired when the Back button is clicked. Normally the Screen.Back action is used here.
This event is fired when the Cancel button, the close button on the title bar, or the Esc key is pressed. Normally the Application.Exit action is used here.
This event is fired when any control on the screen fires a message. You can use this event to respond to any control message. To respond to the message, event variables need to be consulted.
The following event variables are automatically set whenever this event is triggered:
(number) The control id of the control that spawned the event.
(number) The id of the notification message that was fired from the screen control. Each type of control contains its own unique message IDs. These message ids are defined under each control type's topic.
(table) An optional table of details that the control might include. In order to respond to this properly you must consult the specific control type in order to determine what the contents of this table will be. If no details are included, this table will be passed as nil.
This event is fired when a progress screen has completed its progress actions.
This event is fired when the Help button is clicked.
This event is fired when the Next button is clicked. Normally the Screen.Next action is used here.
This event is fired before the screen is displayed.
Note: At this point the screen and its controls have been created so they can be accessed via Dlg***.SetProperties and Dlg***.GetProperties actions. During that process any session variables used on the screen were expanded, therefore any changes made to the session variables on the On Preload event have no effect on the screen. All changes to session variables must be made earlier in the update, or by re-setting the control's text using the Dlg***.SetProperties actions.
This event is fired from a progress screen to start its progress actions.