ACTIVATE EDITTEXT

7.8.5, PLBCMP GUI Only

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

Where:

label

Optional. A Program Execution Label.

edittext

Required. The name of a previously created EDITTEXT object variable or a pointer to an EDITTEXT 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. The runtime performs no default action for an EDITTEXT object.

2. If the {result} operand is specified, the {result} value is based on the action of the operator. When an action occurs that removes focus from the EDITTEXT object and no data was changed in the edit text object, the value of {result} is set to one. When an action occurs that removes focus from the EDITTEXT object and data was changed in the edit text object, the value of {result} is set to two. When an action occurs that sets focus to the EDITTEXT object, the value of {result} is set to three.

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 when a mouse click occurs within the screen boundaries of the EDITTEXT.

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. All other object operations, such as scrolling, are automatically performed by the runtime.

8. If the EDITTEXT 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