Language Reference Guide : System Classes : MenuToggle Class
 
Share this page          
MenuToggle Class
The MenuToggle class is a menu item that switches between two settings. OpenROAD provides two ways to indicate the toggle's state to a user: use a special indicator or the text labels on the toggle.
By default, OpenROAD sets the HasIndicator attribute to TRUE and supplies a marker for the toggle that indicates when the toggle is on or off.
OpenROAD displays the OffTextLabel text string on the toggle when it is off and the OnTextLabel text string when the toggle is on. If you do not use the indicator to show the toggle's state, you can choose labels that fill this function.
The variable for a MenuToggle is of type integer with a value of zero for the Off state and a value of one for the On state.
You can also define events for MenuToggles. These events are processed when the toggle is selected.
Inherits From
Object Class
FieldObject Class
MenuField Class
MenuItem Class
MenuButton Class
Inherited By
None
Attributes
HasIndicator
OffTextLabel
OnTextLabel
Methods
None