Method Xbp3State():getData() Foundation

Returns the current state of a three state button.

Syntax
:getData() --> nValue
Return

This method returns a numeric value representing the current state of a three state button. The following constants are defined for the valid states in the XBP.CH file:

Possible return values
Constant Description
XBP3STATE_UNSELECTED Not selected
XBP3STATE_SELECTED Selected
XBP3STATE_IDLE Undefined

Description

The method :getData() returns the current state of an Xbp3State object. If a code block is contained in the instance variable :dataLink, this data code block is also executed. The current value stored in the edit buffer is passed to the code block (see DataRef()).

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.