ACTIVATE CHECKBOX

7.8.5, PLBCMP GUI Only

The ACTIVATE CHECKBOX statement makes a CHECKBOX visible and allows the user to interact with it. An optional execution label may be provided to process information if the user selects the CHECKBOX. The instruction uses the following format:

[label]

ACTIVATE

{checkbox}[,{routine},{result}]

Where:

label

Optional. A Program Execution Label.

checkbox

Required. The name of a previously created CHECKBOX object variable or a pointer to a CHECKBOX object.

routine

Optional. A program execution label called when a mouse click occurs within the screen boundaries of the object.

result

Optional. A previously defined Numeric Variable in which the result code as described below is placed upon object selection.

Flags Affected: NONE

Note the following:

If the {routine} and {result} operands are not provided, the runtime performs a default action of turning off or on the CHECKBOX. Otherwise, it is the user’s responsibility.
If the {result} operand is specified, it is set to one (1) if the box is checked or zero (0) if it is clear.
If {routine} and {result} operands are provided, it is the user's responsibility to change the state of the CHECKBOX using the SETITEM instruction.
The {routine} is called as if an instruction was performed. It is only called when an EVENTCHECK or EVENTWAIT is executed.
When the {routine} is complete, a RETURN instruction continues execution at the instruction following the EVENTWAIT or EVENTCHECK. Otherwise, a NORETURN instruction should be executed to clear the return address from the call stack.
The {routine} is called when a mouse click occurs within the screen boundaries of the CHECKBOX or when the Alt Keyboard Sequence, if defined, is pressed.
If the CHECKBOX specified by an ACTIVATE instruction is already active, the old {routine} and {result} operands are replaced with the new {routine} and {result} operands.
An object must be CREATEd before it is activated. If this is not done, a runtime error of O105 is generated.
If insufficient memory is available to perform the operation, a runtime error O106 is generated.
If a FILEPI instruction is active, it is terminated.