CheckValidate Method (WINDOW)

PLBCMP GUI Only

The CheckValidate method generates a VALIDATE event for the current GUI object on the WINDOW which has the focus and has the VALIDATE event registered. This method allows a PL/B program to generate a VALIDATE event without have any end-user UI action and without having to know which GUI object has the focus. The method uses the following format:

[label]

{object}.CheckValidate

[GIVING {return}]

Where:

label

Optional. A Program Execution Label.

object

Required. A WINDOW object that is accessed.

return

Optional. A Numeric Variable that receives the result of the method.

Flags Affected: EOS, OVER, ZERO

Note the following:

If the {return} value is zero, this indicates that no VALIDATE event is generated. If a VALIDATE event is generated, the OBJECTID of the GUI object that received the VALIDATE event is returned. If the GUI object that received the VALIDATE event has an OBJECTID value of zero, the value of 99999 is returned.
The OVER flag is set TRUE if the {return} numeric variable is too small to receive the return value.
The EOS flag is always set to be FALSE.
If there are no GUI objects on the WINDOW with the focus, the return value is zero and no VALIDATE event is generated.
A VALIDATE event can only be generated for a GUI object that has the focus and has the $VALIDATE event registered.

See Also: Method Syntax, WINDOW Methods