ACTIVATE COLLECTION

PLBCMP GUI Only

 

The ACTIVATE COLLECTION statement makes all the objects in a COLLECTION visible and allows the user to interact with them. Activating a COLLECTION of objects is also faster than activating each object separately. An optional execution label may be provided to process information if the user selects an object within the COLLECTION. The instruction uses the following format:

 

 

[label]

ACTIVATE

{collection}[,{routine},{result}]

 

Where:

label

Optional. A Program Execution Label.

collection

Required. The name of a previously created COLLECTION object variable or a pointer to a COLLECTION 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 simply makes the objects visible.

  2. If the {result} operand is specified, it is set to indicate the result from the selected object.

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

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

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

  6. All other object operations, such as scroll bar manipulation and screen updating are automatically performed by the runtime.

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

  8. Objects within the COLLECTION must be CREATEd before being activated. If this is not done, a runtime error of O105 is generated.

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

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

 

 

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

 


PL/B Language Reference ACTIVATE CHECKGRP ACTIVATE COMBOBOX