Overview
A check box control is a tool used to collect a true or false value from the user on a screen. This control contains two visual states. An example of a check box and its two states can be seen below:
A 'checked' check box control:
An 'unchecked' check box control:
Additional features of the check box control can be found in the following two categories:
A notification message is triggered whenever the user interacts with a control, or whenever user interaction affects a control in some way. Each notification message consists of a number that identifies the type of interaction that has occurred, and a table containing details specific to that type of interaction. These two values are passed to the screen's On Ctrl Message event as the event variables e_MsgID and e_Details.
Note: Notification messages are not triggered when actions interact with this control.
(number)
e_MsgID
A numeric constant that represents the specific notification message that
was fired by the screen control. See the e_MsgID column below for all
possible message ids that can be fired by a check box control.
(table) e_Details
A table of additional details that may be passed by the control when certain
notification messages are fired. See the e_Details column below for the
kinds of details that are returned and the table indexes that you can
use to access them. For example, you can access the item "Checked"
from this table by using e_Details.Checked.
|
e_MsgID |
e_Details |
Description |
|
MSGID_CLICKED |
(boolean) Checked - Whether the check box is checked or not. The value true means it is checked and false means it is not. |
Fired when the check box was clicked. |
The following actions are available for interacting with a check box control: