Jump to content

IOName class: Difference between revisions

From LabVIEW Wiki
Started page
 
Updated for LabVIEW 2020. Removed template.
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{VIServerClass|name=IOName|id=28|scope=basic|class_0=Generic|class_1=GObject|class_2=Control|class_3=IOName}}
{{VIServerClass|28}}


{{stub}}
{{stub}}
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
== Properties ==
<span class="mw-customtoggle-propertiestable">Show/Hide IOName Properties Table</span>
<span class="mw-customtoggle-propertiestable">Show/Hide IOName Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"  
|+ IOName Properties Table
|+ IOName Properties Table
! Property ID
! data-sort-type="number"| Property ID
! Short Name (English)
! Long Name (English)
! Description
! Description
! R/W
! R/W
! RTE
! RTE  
|- style="background-color:#D1BB80;"
|- style="background-color:#FFAAAA;"  
|6346417
| data-sort-value=104096768 |6346400
| [[IOName class/AllowNew property|AllowNew]]
| [[IOName class/Text Size property|Text Size]]
|
|  
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#FFAAAA;"  
|634640C
| data-sort-value=104096769 |6346401
| [[IOName class/AllowMultiple property|AllowMultiple]]
| [[IOName class/Text Size.Width property|Text Size:Width]]
|
| Width of the I/O name control in pixels.
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#FFAAAA;"  
|634640B
| data-sort-value=104096770 |6346402
| [[IOName class/AllowUndefined property|AllowUndefined]]
| [[IOName class/Text Size.Height property|Text Size:Height]]
|
| Height of the I/O name control in pixels.
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#CCFFFF;"
|- style="background-color:#FFFFCC;"  
|6346410
| data-sort-value=104096771 |6346403
| [[IOName class/DefVal property|DefVal]]
| [[IOName class/Text property|Text]]
|Gets or sets the default value of the I/O name control.
| Reference to the I/O name text.
|R/W
| Read Only
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"
|6346406
| data-sort-value=104096772 |6346404
| [[IOName class/TypeClass property|TypeClass]]
|
| Read/Write
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104096773 |6346405
| [[IOName class/SubTypeClass property|SubTypeClass]]
|
| Read/Write
| Yes
|- style="background-color:#D1BB80;"  
| data-sort-value=104096774 |6346406
| [[IOName class/Device String property|Device String]]
| [[IOName class/Device String property|Device String]]
|
|  
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"  
|634640A
| data-sort-value=104096775 |6346407
| [[IOName class/FilterOnTypeClass property|FilterOnTypeClass]]
|
| Read/Write
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104096776 |6346408
| [[IOName class/FilterOnSubTypeClass property|FilterOnSubTypeClass]]
|
| Read/Write
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104096777 |6346409
| [[IOName class/FilterOnDevice property|FilterOnDevice]]
|
| Read/Write
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104096778 |634640A
| [[IOName class/DisplayFilter property|DisplayFilter]]
| [[IOName class/DisplayFilter property|DisplayFilter]]
|
|  
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"  
|634640D
| data-sort-value=104096779 |634640B
| [[IOName class/DropDownList() property|DropDownList()]]
| [[IOName class/AllowUndefined property|AllowUndefined]]
|
|
|R
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"
|6346419
| data-sort-value=104096780 |634640C
| [[IOName class/AllowMultiple property|AllowMultiple]]
|
| Read/Write
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104096781 |634640D
| [[IOName class/DropDownList() property|DropDownList[]]]
|
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104096782 |634640E
| [[IOName class/Value property|Value]]
| Value of the I/O name control.
| Read/Write
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104096783 |634640F
| [[IOName class/TagType property|TagType]]
|
| Read Only
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104096784 |6346410
| [[IOName class/Default Value property|Default Value]]
| Gets or sets the default value of the I/O name control.
| Read/Write
| Yes (Read Only)
|- style="background-color:#FFFFCC;"
| data-sort-value=104096785 |6346411
| [[IOName class/Value (Signaling) property|Value (Signaling)]]
| Sets the value of the control and generates a Value Change event.
| Write Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104096786 |6346412
| [[IOName class/Size property|Size]]
| Size of the I/O name control in terms of width and height in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104096787 |6346413
| [[IOName class/Size.Width property|Size:Width]]
| Width of the I/O name control in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104096788 |6346414
| [[IOName class/Size.Height property|Size:Height]]
| Height of the I/O name control in pixels.
| Read/Write
| Yes
|- style="background-color:#FFAAAA;"
| data-sort-value=104096789 |6346415
| [[IOName class/TagList() property|TagList[]]]
|
| Read Only
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104096790 |6346416
| [[IOName class/IncludeInvalid property|IncludeInvalid]]
|
| Read/Write
| Yes
|- style="background-color:#D1BB80;"  
| data-sort-value=104096791 |6346417
| [[IOName class/AllowCreateNew property|AllowCreateNew]]
|
| Read/Write
| Yes
|- style="background-color:#FFAAAA;"
| data-sort-value=104096792 |6346418
| [[IOName class/UpdatedTagList() property|UpdatedTagList[]]]
|
| Read Only
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104096793 |6346419
| [[IOName class/FilterCriteria property|FilterCriteria]]
| [[IOName class/FilterCriteria property|FilterCriteria]]
|
|  
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"  
|6346409
| data-sort-value=104096794 |634641A
| [[IOName class/FilterOnDevice property|FilterOnDevice]]
| [[IOName class/User Data property|User Data]]
|
|  
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#FFFFCC;"  
|6346408
| data-sort-value=104096795 |634641B
| [[IOName class/FilterOnSubTypeClass property|FilterOnSubTypeClass]]
| [[IOName class/Menu Button Visible property|Menu Button Visible]]
|
| If True, displays the pull-down menu button.
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"  
|6346407
| data-sort-value=104096796 |634641C
| [[IOName class/FilterOnTypeClass property|FilterOnTypeClass]]
| [[IOName class/Synch Current And Default Values property|Synch Current And Default Values]]
|
|  
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"  
|634641D
| data-sort-value=104096797 |634641D
| [[IOName class/GrayedWhenVIReserved property|GrayedWhenVIReserved]]
| [[IOName class/Grayed When VI Reserved property|Grayed When VI Reserved]]
|
|  
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"  
|634641E
| data-sort-value=104096798 |634641E
| [[IOName class/IgnoreSeparators property|IgnoreSeparators]]
| [[IOName class/Ignore Separators property|Ignore Separators]]
|
|  
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#D1BB80;"  
|6346416
| data-sort-value=104096799 |634641F
| [[IOName class/InclInvalid property|InclInvalid]]
| [[IOName class/DropDownGlyphStatus property|DropDownGlyphStatus]]
|
|  
|R/W
| Read Only
|X
| Yes
|- style="background-color:#FFFFCC;"
|634641B
| [[IOName class/MenuButtonVisible property|MenuButtonVisible]]
|If True, displays the pull-down menu button.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6346412
| [[IOName class/Size property|Size]]
|Size of the I/O name control in terms of width and height in pixels.
 
This property is similar to the <b>Size Height</b> and <b>Size Width</b> options on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6346414
| [[IOName class/Height property|Height]]
|Height of the I/O name control in pixels.
 
This property is an element of the Size property. This property is similar to the <b>Size Height</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6346413
| [[IOName class/Width property|Width]]
|Width of the I/O name control in pixels.
 
This property is an element of the Size property. This property is similar to the <b>Size Width</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#D1BB80;"
|6346405
| [[IOName class/Sub property|Sub]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|634641C
| [[IOName class/SynchCurDfltVals property|SynchCurDfltVals]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|634640F
| [[IOName class/TagType property|TagType]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|6346403
| [[IOName class/Text property|Text]]
|Reference to the I/O name text.
 
You can use this reference with the Text properties.
|R
|X
|- style="background-color:#D1BB80;"
|6346404
| [[IOName class/TypeClass property|TypeClass]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|634641A
| [[IOName class/UserData property|UserData]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|634640E
| [[IOName class/Value property|Value]]
|Value of the I/O name control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6346411
| [[IOName 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>
</div></div>


==Methods==
== Methods ==
''No Methods for this class.''
''This class has no methods or it inherits methods from its parent: [[Control class#Methods|Control Class]].''


==Events==
== Events ==
<span class="mw-customtoggle-eventstable">Show/Hide IOName Events Table</span>
<span class="mw-customtoggle-eventstable">Show/Hide IOName Events Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
{{VIServerLegend}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
{| class="wikitable sortable"
|+ IOName Events Table
|+IOName Events Table
! Code
! data-sort-type="number"| Code
! Name
! Name
! Description
! Type
! Type
|- style="background-color:#D1BB80;"
|- style="background-color:#FFFFCC;"  
|1073741890
| data-sort-value=4294967295 |1073741890
|[[IOName class/Operate Menu Activation event|Operate Menu Activation]]
| [[IOName class/Operate Menu Activation event|Operate Menu Activation]]
|Notify
|
|- style="background-color:#D1BB80;"
| Notify
|1073741891
|- style="background-color:#FFFFCC;"  
|[[IOName class/Operate Menu Dismissed event|Operate Menu Dismissed]]
| data-sort-value=4294967295 |1073741891
|Notify
| [[IOName class/Operate Menu Dismissed event|Operate Menu Dismissed]]
|
| Notify
|}
|}
</div>
</div></div>
 


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
! Change(s)
! Change(s)
|-
|-
|[[File:LV2018.png|frameless|border|64x64px|LabVIEW 2018|link=LabVIEW 2018]]
|[[File:LV2020.png|frameless|border|64x64px|LabVIEW 2020|link=LabVIEW 2020]]
|More info to come.
| In [[LabVIEW 2020]] the [[IOName class/DropDownGlyphStatus property|DropDownGlyphStatus property]] was added.
|}
|}


Line 225: Line 256:
*[[VI Scripting]]
*[[VI Scripting]]


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

Latest revision as of 03:25, 17 June 2020

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


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

Properties

Show/Hide IOName Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
IOName Properties Table
Property ID Long Name (English) Description R/W RTE
6346400 Text Size Read/Write Yes
6346401 Text Size:Width Width of the I/O name control in pixels. Read/Write Yes
6346402 Text Size:Height Height of the I/O name control in pixels. Read/Write Yes
6346403 Text Reference to the I/O name text. Read Only Yes
6346404 TypeClass Read/Write Yes
6346405 SubTypeClass Read/Write Yes
6346406 Device String Read/Write Yes
6346407 FilterOnTypeClass Read/Write Yes
6346408 FilterOnSubTypeClass Read/Write Yes
6346409 FilterOnDevice Read/Write Yes
634640A DisplayFilter Read/Write Yes
634640B AllowUndefined Read/Write Yes
634640C AllowMultiple Read/Write Yes
634640D DropDownList[] Read Only Yes
634640E Value Value of the I/O name control. Read/Write Yes
634640F TagType Read Only Yes
6346410 Default Value Gets or sets the default value of the I/O name control. Read/Write Yes (Read Only)
6346411 Value (Signaling) Sets the value of the control and generates a Value Change event. Write Only Yes
6346412 Size Size of the I/O name control in terms of width and height in pixels. Read/Write Yes
6346413 Size:Width Width of the I/O name control in pixels. Read/Write Yes
6346414 Size:Height Height of the I/O name control in pixels. Read/Write Yes
6346415 TagList[] Read Only Yes
6346416 IncludeInvalid Read/Write Yes
6346417 AllowCreateNew Read/Write Yes
6346418 UpdatedTagList[] Read Only Yes
6346419 FilterCriteria Read/Write Yes
634641A User Data Read/Write Yes
634641B Menu Button Visible If True, displays the pull-down menu button. Read/Write Yes
634641C Synch Current And Default Values Read/Write Yes
634641D Grayed When VI Reserved Read/Write Yes
634641E Ignore Separators Read/Write Yes
634641F DropDownGlyphStatus Read Only Yes

Methods

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

Events

Show/Hide IOName Events Table

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


History

Version Change(s)
LabVIEW 2020 In LabVIEW 2020 the DropDownGlyphStatus property was added.

See Also