Boolean class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	class
Class ID	{{{1}}}
Scope
Class Inheritance	This class is a top-level class.
Class Children	This class has no children.

The Boolean class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Boolean Properties Table

Legend
R/W	Readable/Writable Permissions
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

Boolean Properties Table

Property ID	Short Name (English)	Description	R/W	RTE
6333806	BoolText	Reference to the Boolean text object. You can use this reference to change the text color, font, size, and so on of the Boolean text object. You can use this reference with the Text properties.	R	X
6333801	BtnSize	The width and height of the button in pixels.	R/W	X
6333803	Height	Height of the button in pixels. This property is an element of the Button Size property.	R/W	X
6333802	Width	Width of the button in pixels. This property is an element of the Button Size property.	R/W	X
6333805	Colors(4)	Array of up to 4 (Foreground Color, Background Color) pairs, where Foreground Color is the foreground color of the Boolean control and Background Color is the background color of the Boolean control. Color pairs include False, True, True to False, and False to True. You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property. This property is similar to the Colors option on the Appearance page of the Boolean Properties dialog box. If the Boolean control has four (Foreground Color, Background Color) pairs for the four states, this property always returns an array of four (Foreground Color, Background Color) pairs when reading. When writing, you can pass in an array of length 1, 2 or 4. If you pass in only one element, this property uses that element value for all four states. If you pass in two elements, this property uses the first element value for the False and True to False states. Similarly, this property uses the second element for the True and False to True states. If the Boolean control has only one (Foreground Color, Background Color) pair for all four states, this property returns an array of one (Foreground Color, Background Color) pair when reading, and uses the first array element when writing. You cannot change a Boolean control with one (Foreground Color, Background Color) pair to a Boolean control with multiple (Foreground Color, Background Color) pairs. This property only uses the True to False and False to True states when you set the Boolean control to latch or switch when released. You can get and set these (Foreground Color, Background Color) pairs even if you do not have the control set to latch or switch when released; they just are not used. Because this property does not change the data of the Boolean control, you can set it at any time. You can use this property for Boolean controls on the Classic, Express, Modern, and Silver palettes. You cannot use this property for Boolean controls on the System palette.	R/W	X
633380C	DecalScaling		R/W	X
6333809	IsTracking		R	X
6333807	LockBoolText	Indicates whether the Boolean text should be locked in the center of the Boolean object. This property is similar to the Release Text and Lock Text in Center items on the shortcut menu of a Boolean object. This property also is similar to the Lock text in center option on the Appearance page of the Boolean Properties dialog box.	R/W	X
6333808	MechAction	Mechanical action (0-5) as shown in the shortcut menu from top left to bottom right.	R/W
633380A	MultiStrs	Specifies whether the Boolean control has multiple text strings.	R/W	X
6333804	Strings(4)	Array of up to 4 strings. Strings include text for False, True, True to False, and False to True. If you set the Boolean control to allow multiple strings, this property always returns an array of four strings when reading. When writing, you can pass in an array of length 1, 2 or 4. If you pass in only one element, this property uses that element value for all four states. If you pass in two elements, this property uses the first element value for the False and True to False states. Similarly, this property uses the second element for the True and False to True states. If you do not set the Boolean control to allow multiple strings, this property returns an array of one string when reading, and uses the first array element when writing. This property only uses the True to False and False to True states when you set the Boolean control to latch or switch when released. You can get and set these strings even if you do not have the control set to latch or switch when released; they just are not used.	R/W	X
633380B	ToggleKeyBind	Sets a shortcut key to toggle this control. This property is similar to the Toggle option on the Key Navigation page of the Boolean Properties dialog box. Elements: Name Description Control If TRUE, the keyboard shortcut includes the key. Shift If TRUE, the keyboard shortcut includes the key. Key The name of the shortcut key. (Mac OS X) LabVIEW does not support <VolumeUp>, <VolumeDown>, and function keys<F15> to <F24> as shortcut keys on Mac OS X. Key must match one of the following values: <Clear> <Ins> <Del> <Home> <End> <PageUp> <PageDown> <Escape> <Enter> Note The <Enter> key on the alphanumeric keyboard and <Enter> key on the numeric keypad are the same value. <Play> <VolumeUp> <VolumeDown> <Mute> F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 F13 F14 F15 F16 F17 F18 F19 F20 F21 F22 F23 F24 Note You must use the English Key name when wiring a shortcut key value.	R/W	X

Methods

No Methods for this class.

Events

No Events for this class.

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server
• VI Scripting