Jump to content

Ring class: Difference between revisions

From LabVIEW Wiki
← Older edit
VisualWikitext
mNo edit summary
Updated for LabVIEW 2020. Removed template.
 
(2 intermediate revisions by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
== Properties ==
<span class="mw-customtoggle-propertiestable">Show/Hide Ring Properties Table</span>
<span class="mw-customtoggle-propertiestable">Show/Hide Ring 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"  
|+ Ring Properties Table
|+ Ring 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:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|633E000
| data-sort-value=104062976 |633E000
| [[Ring class/AllowUndefVals property|AllowUndefVals]]
| [[Ring class/Allow Undefined Values property|Allow Undefined Values]]
|If TRUE, users can enter numeric values not already associated with any entries in the list of items defined for a ring control. Users must enter undefined numeric values in the digital display of the control. If FALSE, users must select from the list of items defined for the control.
| If TRUE, users can enter numeric values not already associated with any entries in the list of items defined for a ring control. Users must enter undefined numeric values in the digital display of the control. If FALSE, users must select from the list of items defined for the control.
 
| Read/Write
This property is similar to the Allow Undefined Values item on the shortcut menu of a ring control and the <b>Allow undefined values at run time</b> checkbox on the Edit Items page of the <b>Ring Control Properties</b> dialog box.
| Yes
|R/W
|- style="background-color:#D1BB80;"
|X
| data-sort-value=104062979 |633E003
|- style="background-color:#D1BB80;"
| [[Ring class/Values () property|Values []]]
|633E007
|
| [[Ring class/DropDownMenu property|DropDownMenu]]
| Read/Write
|
| Yes
|R/W
|- style="background-color:#FFFFCC;"  
|X
| data-sort-value=104062980 |633E004
|- style="background-color:#D1BB80;"
| [[Ring class/Strings And Values () property|Strings And Values []]]
|633E006
| Array of clusters containing the strings (non-sequential) from which you can select in the ring control and the numeric values for each item. Use the [[Strings ()]] property if you do not need to assign specific numeric values to each item.
| Read/Write
| Yes
|- style="background-color:#CCFFFF;"  
| data-sort-value=104062982 |633E006
| [[Ring class/Flavor property|Flavor]]
| [[Ring class/Flavor property|Flavor]]
|
| Returns a value describing the ring type: Text Ring, Pict Ring, or Text and Pict Ring.
|R
| Read Only
|X
| Yes
|- style="background-color:#FFFFCC;"
|- style="background-color:#D1BB80;"
|633E004
| data-sort-value=104062983 |633E007
| [[Ring class/StringsAndValues() property|StringsAndValues()]]
| [[Ring class/Drop Down Menu property|Drop Down Menu]]
|Array of clusters containing the strings (non-sequential) from which you can select in the ring control and the numeric values for each item. Use the Strings [] property if you do not need to assign specific numeric values to each item.
|
 
| Read/Write
If you wire the same numeric values to this property, LabVIEW returns an error.
| Yes
|- style="background-color:#FFFFCC;"  
| data-sort-value=104062984 |633E008
| [[Ring class/Last Value Hidden property|Last Value Hidden]]
| When TRUE, hides the last item in a ring (picture or string) from the selection list and prevents that item from being selected using up/down arrow selection or other UI interactions. Use this property to put an item into the selection that can only be there as a default and never as the result of user interaction.
| Read/Write
| Yes
|}
</div></div>


This property is similar to the <b>Labels</b> and <b>Values</b> columns on the Edit Items page of the <b>Ring Properties</b> dialog box.
== Methods ==
 
''This class has no methods or it inherits methods from its parent: [[NamedNumeric class#Methods|NamedNumeric Class]].''
{| 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 ring control.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Value
|The corresponding value for the string.
|}
|R/W
|X
|- style="background-color:#D1BB80;"
|633E003
| [[Ring class/Values() property|Values()]]
|
|R/W
|X
|}
</div>


==Methods==
== Event ==
''No Methods for this class.''
''This class has no events or it inherits events from its parent: [[NamedNumeric class#Events|NamedNumeric Class]].''


==Events==
''No Events for this class.''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occurred 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 following changes were made:
* The [[Ring class/Flavor property|Flavor property]] was changed from [[VI Server#Private|Private]] to [[VI Server#VI Scripting|VI Scripting]].
* The [[Ring class/Last Value Hidden property]] was added.
|}
|}


Line 89: Line 80:
*[[VI Server]]
*[[VI Server]]


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

Latest revision as of 03:32, 17 June 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Ring class
Class ID 34
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 Ring class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Ring Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Ring Properties Table
Property ID Long Name (English) Description R/W RTE
633E000 Allow Undefined Values If TRUE, users can enter numeric values not already associated with any entries in the list of items defined for a ring control. Users must enter undefined numeric values in the digital display of the control. If FALSE, users must select from the list of items defined for the control. Read/Write Yes
633E003 Values [] Read/Write Yes
633E004 Strings And Values [] Array of clusters containing the strings (non-sequential) from which you can select in the ring control and the numeric values for each item. Use the Strings () property if you do not need to assign specific numeric values to each item. Read/Write Yes
633E006 Flavor Returns a value describing the ring type: Text Ring, Pict Ring, or Text and Pict Ring. Read Only Yes
633E007 Drop Down Menu Read/Write Yes
633E008 Last Value Hidden When TRUE, hides the last item in a ring (picture or string) from the selection list and prevents that item from being selected using up/down arrow selection or other UI interactions. Use this property to put an item into the selection that can only be there as a default and never as the result of user interaction. Read/Write Yes

Methods

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

Event

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


History

Version Change(s)
LabVIEW 2020 In LabVIEW 2020 the following changes were made:

See Also

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