ACTIVATE CHECKGRP

7.8.5, PLBCMP GUI Only

 

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

 

 

[label]

ACTIVATE

{checkgrp}[,{routine},{result}]

 

Where:

label

Optional. A Program Execution Label.

checkgrp

Required. The name of a previously created CHECKGRP object variable or a pointer to a CHECKGRP 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:

  1. If the {routine} and {result} operands are not provided, the runtime performs a default action of turning off or on the appropriate checkbox.

  2. If the {result} operand is specified, it is set to indicate the item that was selected.

  3. If {routine} and {result} operands are provided, it is the user's responsibility to change the state of the CHECKGRP using the SETITEM instruction.

  4. If the {result} operand is too small to contain the value, the OVER flag is set upon entry to the {routine}. This flag setting does not occur at the time of the ACTIVATE butat the time the +{routine} is called.

  5. The {routine} is called as if a CALL instruction was performed. It is only called when an EVENTCHECK or EVENTWAIT is executed.

  6. 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.

  7. The {routine} is called when a mouse click occurs within the screen boundaries of the CHECKGRP or when the Alt Keyboard Sequence, if defined, is pressed.

  8. If the CHECKGRP specified by an ACTIVATE instruction is already active, the old {routine} and {result} operands are replaced with the new {routine} and {result} operands.

  9. An object must be CREATEd before it is activated. If this is not done, a runtime error of O105 is generated.

  10. If insufficient memory is available to perform the operation, a runtime error O106 is generated.

  11. If a FILEPI instruction is active, it is terminated.

 

 

See Also: Example Code, ACTIVATE, DEACTIVATE, Object Output Instructions

 


PL/B Language Reference ACTIVATE CHECKBOX ACTIVATE COLLECTION