Jump to content

Boolean class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
VisualWikitext
mNo edit summary
Replaced with template tables
Tag: Replaced
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide Boolean Properties Table</span>
{{VIServerClassTables|8}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Boolean Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6333806
| [[Boolean class/BoolText property|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
|- style="background-color:#FFFFCC;"
|6333801
| [[Boolean class/BtnSize property|BtnSize]]
|The width and height of the button in pixels.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6333803
| [[Boolean class/Height property|Height]]
|Height of the button in pixels.
 
This property is an element of the Button Size property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6333802
| [[Boolean class/Width property|Width]]
|Width of the button in pixels.
 
This property is an element of the Button Size property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6333805
| [[Boolean class/Colors(4) property|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 <b>Colors</b> option on the Appearance page of the <b>Boolean Properties</b> 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 <b>Classic</b>, <b>Express</b>, <b>Modern</b>, and <b>Silver</b> palettes. You cannot use this property for Boolean controls on the <b>System</b> palette.
|R/W
|X
|- style="background-color:#D1BB80;"
|633380C
| [[Boolean class/DecalScaling property|DecalScaling]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|6333809
| [[Boolean class/IsTracking property|IsTracking]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|6333807
| [[Boolean class/LockBoolText property|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 <b>Lock text in center</b> option on the Appearance page of the <b>Boolean Properties</b> dialog box.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6333808
| [[Boolean class/MechAction property|MechAction]]
|Mechanical action (0-5) as shown in the shortcut menu from top left to bottom right.
|R/W
|
|- style="background-color:#CCFFFF;"
|633380A
| [[Boolean class/MultiStrs property|MultiStrs]]
|Specifies whether the Boolean control has multiple text strings.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6333804
| [[Boolean class/Strings(4) property|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
|- style="background-color:#FFFFCC;"
|633380B
| [[Boolean class/ToggleKeyBind property|ToggleKeyBind]]
|Sets a shortcut key to toggle this control.
 
This property is similar to the <b>Toggle</b> option on the Key Navigation page of the <b>Boolean Properties</b> dialog box.
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Control
|If TRUE, the keyboard shortcut includes the  key.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Shift
|If TRUE, the keyboard shortcut includes the  key.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|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:
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
*<Clear>
*<nowiki><Ins></nowiki>
*<nowiki><Del></nowiki>
*<Home>
*<End>
*<PageUp>
*<PageDown>
*<Escape>
*<Enter>
:<b>Note</b> 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
:<b>Note</b>  You must use the English Key name when wiring a shortcut key value.
</div>
|}
|R/W
|X
|}
</div>
 
==Methods==
''No Methods for this class.''
 
==Events==
''No Events for this class.''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version

Revision as of 21:40, 8 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Boolean class
Class ID 8
Scope Basic Development Environment
Class Inheritance
Class Children

This class has no children.


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

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

Properties

Show/Hide Boolean Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Boolean Properties Table
Property ID Long Name (English) Description R/W RTE
6333801Button SizeThe width and height of the button in pixels.Read/WriteYes
6333802Button Size:WidthWidth of the button in pixels.Read/WriteYes
6333803Button Size:HeightHeight of the button in pixels.Read/WriteYes
6333804Strings [4]Array of up to 4 strings. Strings include text for False, True, True to False, and False to True.Read/WriteYes
6333805Colors [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.Read/WriteYes
6333806Boolean TextReference 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.Read OnlyYes
6333807Lock Boolean Text In CenterIndicates whether the Boolean text should be locked in the center of the Boolean object.Read/WriteYes
6333808Mechanical ActionMechanical action (0-5) as shown in the shortcut menu from top left to bottom right.Read/WriteNo
6333809IsTrackingRead OnlyYes
633380AMultiple Text StringSpecifies whether the Boolean control has multiple text strings.Read/WriteYes
633380BToggle Key BindingSets a shortcut key to toggle this control.Read/WriteYes
633380CDecal Scaling?Read/WriteYes

Methods

This class has no methods or it inherits methods from its parent: Control Class.

Events

This class has no events or it inherits events from its parent: Control Class.


History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=Boolean_class&oldid=9741"