Jump to content

ComboBox class: Difference between revisions

From LabVIEW Wiki
mNo edit summary
m Removed VI Sever Category from page
 
(2 intermediate revisions by the same user not shown)
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 ComboBox Properties Table</span>
{{VIServerClassTables|29}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ ComboBox Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6347002
| [[ComboBox class/AllowUndefStrs property|AllowUndefStrs]]
|If TRUE, users can enter string values not already in the list of strings defined for the combo box control. If FALSE, users must select from the list of strings defined for the control.
 
This property is similar to the Allow Undefined Strings item on the shortcut menu of a combo box control and to the <b>Allow undefined values at run time</b> option on the Edit Items page of the <b>Combo Box Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6347006
| [[ComboBox class/CaseSensitivePopup property|CaseSensitivePopup]]
|Reads or writes whether the selection pop-up on the combo box can distinguish between entries that are the same, but have different cases.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6347001
| [[ComboBox class/DefVal property|DefVal]]
|Gets or sets the default value of the combo box control.
|R/W
|X
|- style="background-color:#D1BB80;"
|6347007
| [[ComboBox class/MatchFirst property|MatchFirst]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|6347004
| [[ComboBox class/StringsAndValues() property|StringsAndValues()]]
|Array of clusters containing the strings from which you can select in the combo box control and the values for each string. Use the Strings [] property if you do not need to specify custom values for each string.
 
If you wire strings to this property but you do not wire any values, LabVIEW sets the values equal to the strings you wired. If you wire the same values to this property, LabVIEW returns an error.
 
This property is similar to the Edit Items item on the shortcut menu of a combo box control and to the <b>Labels</b> and <b>Values</b> options on the Edit Items page of the <b>Combo Box 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;"|String
|A string in the combo box.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Value
|The corresponding value for the string.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|6347003
| [[ComboBox class/Strings() property|Strings()]]
|Array of the strings from which you can select in the combo box control. Use the Strings And Values [] property to specify custom values for each string.
 
If you use this property with a combo box control that has custom values, the number of values for the combo box control determines the number of strings you can set using this property. For example, if the combo box control has the values Free, Discount, and Full, you can set only three strings using this property.
 
If the combo box control has more values than the number of strings you wire to this property, LabVIEW creates strings for any values that do not have corresponding strings. For example, if the combo box control has the values Free, Discount, and Full and you wire the strings Voucher and Coupon to this property, LabVIEW sets the last string to .
 
This property is similar to the Edit Items item on the shortcut menu of a combo box control and to the <b>Labels</b> option on the Edit Items page of the <b>Combo Box Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6347000
| [[ComboBox class/Value property|Value]]
|Value of the ComboBox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6347005
| [[ComboBox class/Val(Sgnl) property|Val(Sgnl)]]
|Sets the value of the control and generates a Value Change event.
 
This property updates the value of an object similar to the Value property. However, Value (Signaling) also causes LabVIEW to generate an event as if the user had interactively changed the value of the object. National Instruments recommends you use this property only when you rely on LabVIEW generating an event in response to the programmatic value change.
|W
|X
|}
</div>
 
==Methods==
''No Methods for this class.''
 
==Events==
<span class="mw-customtoggle-eventstable">Show/Hide ComboBox Events Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
{| class="wikitable sortable"
|+ ComboBox Events Table
! Code
! Name
! Type
|- style="background-color:#D1BB80;"
|1073741890
|[[ComboBox class/Operate Menu Activation event|Operate Menu Activation]]
|Notify
|- style="background-color:#D1BB80;"
|1073741891
|[[ComboBox class/Operate Menu Dismissed event|Operate Menu Dismissed]]
|Notify
|}
</div>


== History ==
== History ==
Line 133: Line 25:
*[[VI Scripting]]
*[[VI Scripting]]


[[Category:VI Server]]
[[Category:VI Server Class]]
[[Category:VI Server Class]]
[[Category:VI Scripting]]

Latest revision as of 01:44, 8 May 2020

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

This class has no children.


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

Properties

Show/Hide ComboBox Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
ComboBox Properties Table
Property ID Long Name (English) Description R/W RTE
6347000ValueValue of the ComboBox control.Read/WriteYes
6347001Default ValueGets or sets the default value of the combo box control.Read/WriteYes (Read Only)
6347002Allow Undefined StringsIf TRUE, users can enter string values not already in the list of strings defined for the combo box control. If FALSE, users must select from the list of strings defined for the control.Read/WriteYes
6347003Strings []Array of the strings from which you can select in the combo box control. Use the Strings And Values () property to specify custom values for each string.Read/WriteYes
6347004Strings And Values []Array of clusters containing the strings from which you can select in the combo box control and the values for each string. Use the Strings () property if you do not need to specify custom values for each string.Read/WriteYes
6347005Value (Signaling)Sets the value of the control and generates a Value Change event.Write OnlyYes
6347006Case Sensitive Pop-upReads or writes whether the selection pop-up on the combo box can distinguish between entries that are the same, but have different cases.Read/WriteYes
6347007MatchFirstInListRead/WriteYes

Methods

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

Events

Show/Hide ComboBox Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
ComboBox Events Table
Code Name Description Type
1073741890Operate Menu Activation
1073741891Operate Menu Dismissed


History

Version Change(s)
LabVIEW 2018 More info to come.

See Also