Toggle

The Toggle block provides a control to input a logical value (on/off, yes/no) to the command.

Inherited general properties

• BlockID
• Enable
• Group
• Label
• Show
• Expanded

Block-specific properties

Property Name	Description	Access	Property Type	List of Values
BalloonTooltipOnText	Specifies text for the balloon tooltip (shown when toggle is ON).	CIGS	String	Any string value. Type \n for a line feed.
BalloonTooltipOffText	Specifies text for the balloon tooltip (shown when toggle is OFF).	CIGS	String	Any string value.
BalloonTooltipOnImage	Specifies the file name of the image displayed in the balloon tooltip when ON.	CIGS	String	Valid bitmap file name from the NX library (no suffix/extension needed), or complete path. Supports TIFF, PNG, GIF, JPEG, BMP.
BalloonTooltipOffImage	Specifies the file name of the image displayed in the balloon tooltip when OFF.	CIGS	String	Same as above.
Bitmap	Specifies the name of the Bitmap image used by this block. If HighQualityBitmap is TRUE, a 24-bit bitmap can be specified, else a 16-bit bitmap is used.	CSG	String	Any valid bitmap image name as a string (full path can also be specified).
Localize	Allows localization of the block Label, translating to the current locale language if the Label matches an English string in the NX string localization database.	CIG	Logical	TRUE — translate Label to current locale. FALSE — do not translate.
RetainValue	Determines if the block's value will be saved in dialog memory (upon OK, Apply, or Close).	CSG	Logical	TRUE — Command will be toggled on [when reopened]. FALSE — Command will be toggled off.
BitmapOnly	Specifies whether to replace the usual toggle field with the bitmap. Functional only if the Bitmap property is specified.	CIG	Logical	TRUE — Replaces toggle field with the bitmap (provided Bitmap is specified). FALSE — Shows both toggle field and bitmap (bitmap shown if Bitmap property is specified).

Access column legend

Character	Stands for	Meaning
C	Creation	Modifiable interactively in Block UI Styler at design time.
I	Initialize	Modifiable at run time via NXOpen API, but only during the Initialize callback.
G	Get	Readable via NXOpen API in any callback.
S	Set	Modifiable at run time via NXOpen API in any callback.

Related Basic blocks

Action Button, Drawing Area, Enumeration, Label/Bitmap, Multi-Line String, Object Color Picker, RGB Color Picker, Separator, String, List Box.