Jump to content

Cluster class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
Visual
mNo edit summary
Replaced with template tables
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 Cluster Properties Table</span>
{{VIServerClassTables|30}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Cluster Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6347C04
| [[Cluster class/AllObjs() property|AllObjs()]]
|Array of references to all the objects (controls and decorations) in the cluster.
 
This property does not use the cluster order to output the array of references to objects in the cluster. Instead, this property outputs the array of references to the cluster in a Z-order, where the first object is the last object inserted into the cluster and the first element in the array of references.
|R
|X
|- style="background-color:#CCFFFF;"
|6347C08
| [[Cluster class/AutoSize property|AutoSize]]
|Gets or sets how LabVIEW auto sizes a cluster.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6347C05
| [[Cluster class/ClusterSize property|ClusterSize]]
|Gets or sets the size of a cluster.
 
<b>Note</b>  If you right-click a cluster and select an <b>AutoSizing</b> option, LabVIEW ignores this property.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6347C07
| [[Cluster class/ClustHeight property|ClustHeight]]
|Gets or sets the height of a cluster.
 
<b>Note</b>  If you right-click a cluster and select an <b>AutoSizing</b> option, LabVIEW ignores this property.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6347C06
| [[Cluster class/ClustWidth property|ClustWidth]]
|Gets or sets the width of a cluster.
 
<b>Note</b>  If you right-click a cluster and select an <b>AutoSizing</b> option, LabVIEW ignores this property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6347C01
| [[Cluster class/Color property|Color]]
|Background color of the cluster.
 
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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6347C02
| [[Cluster class/Controls() property|Controls()]]
|Array of references to the cluster elements in cluster order.
 
Use the To More Generic Class and To More Specific Class functions to cast these references to a class other than the Control class.
|R
|X
|- style="background-color:#FFFFCC;"
|6347C03
| [[Cluster class/Decos() property|Decos()]]
|Array of references to the decorations in the cluster.
|R
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Cluster Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ Cluster Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|6347800
| [[Cluster class/Set Cluster Order method|Set Cluster Order]]
|Specifies the order of elements in the cluster.
|X
|}
</div>
 
==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:43, 8 September 2019

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


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

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

Properties

Show/Hide Cluster Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Cluster Properties Table
Property ID Long Name (English) Description R/W RTE
6347C01ColorBackground color of the cluster.Read/WriteYes
6347C02Controls[]Array of references to the cluster elements in cluster order.Read OnlyYes (Read Only)
6347C03Decorations[]Array of references to the decorations in the cluster.Read OnlyYes (Read Only)
6347C04All Objects[]Array of references to all the objects (controls and decorations) in the cluster.Read OnlyYes (Read Only)
6347C05Cluster SizeGets or sets the size of a cluster.Read/WriteYes
6347C06Cluster Size:WidthGets or sets the width of a cluster.Read/WriteYes
6347C07Cluster Size:HeightGets or sets the height of a cluster.Read/WriteYes
6347C08Auto SizingGets or sets how LabVIEW auto sizes a cluster.Read/WriteYes (Read Only)
6347C09Vertical Scrollbar VisibleRead/WriteYes
6347C0AHorizontal Scrollbar VisibleRead/WriteYes

Methods

Show/Hide Cluster Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Cluster Methods Table
Method ID Long Name (English) Description RTE
6347800Set Cluster OrderSpecifies the order of elements in the cluster.Yes (Read/Write)

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=Cluster_class&oldid=9742"