Jump to content

Panel class: Difference between revisions

From LabVIEW Wiki
Started page
 
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 Panel Properties Table</span>
{{VIServerClassTables|31}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Panel Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6348803
| [[Panel class/AllObjs() property|AllObjs()]]
|Array of references to all the objects (controls and decorations) on the front panel.
|R
|X
|- style="background-color:#FFFFCC;"
|6348801
| [[Panel class/Controls() property|Controls()]]
|Array of references to the controls and indicators on the front panel. The array contains the references in tabbing order.
 
To view or change the tabbing order of controls and indicators, select <b>Edit&#0187;Set Tabbing Order</b>.
 
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;"
|6348802
| [[Panel class/Decos() property|Decos()]]
|Array of references to the decorations on the front panel.
|R
|X
|- style="background-color:#FFFFCC;"
|6348805
| [[Panel class/DeferPanUpdts property|DeferPanUpdts]]
|When you set this property to TRUE, LabVIEW redraws any front panel objects with pending changes then defers all new requests for front panel updates. For example, controls and indicators do not redraw when you change their properties or values.  If the operating system requests a redraw, such as if the window is no longer behind another window, LabVIEW redraws the front panel with the current properties instead of the original properties. If FALSE, LabVIEW immediately redraws the changed elements of the front panel.
 
Setting this property to TRUE can improve the execution speed and memory usage of a VI.
 
<b>Note</b>  This property remains on after the VI finishes. Set this property to turn off before the VI finishes or the front panel cannot update with edits. Do not abort VIs that rely on this property to turn it off.
|R/W
|X
|- style="background-color:#D1BB80;"
|6348809
| [[Panel class/Menu Vis property|Menu Vis]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|6348806
| [[Panel class/Panes() property|Panes()]]
|Returns an array of references to each pane in the pane hierarchy on the panel. You can use this property with the Front Panel property to obtain a reference to a pane in another VI.
|R
|X
|- style="background-color:#FFFFCC;"
|6348804
| [[Panel class/SelList() property|SelList()]]
|Array of references to the selected objects on the front panel.
|R
|X
|- style="background-color:#FFFFCC;"
|6348807
| [[Panel class/Splitters() property|Splitters()]]
|Returns an array of references to each splitter bar in the splitter hierarchy on the panel.
|R
|X
|- style="background-color:#D1BB80;"
|6348808
| [[Panel class/Focus property|Focus]]
|
|R
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Panel Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ Panel Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|6348412
| [[Panel class/AlignSelection method|AlignSelection]]
|Aligns selected objects.
|
|- style="background-color:#CCFFFF;"
|6348402
| [[Panel class/Clear Selection method|Clear Selection]]
|Clears the selection list.
|
|- style="background-color:#FFFFCC;"
|634840F
| [[Panel class/CvtPanelToScreenCoords method|CvtPanelToScreenCoords]]
|Converts front panel coordinates to screen coordinates.
|X
|- style="background-color:#FFFFCC;"
|6348410
| [[Panel class/CvtScreenToPanelCoords method|CvtScreenToPanelCoords]]
|Converts screen coordinates to front panel coordinates.
|X
|- style="background-color:#CCFFFF;"
|6348405
| [[Panel class/Copy Selection method|Copy Selection]]
|Copies objects you select into clipboard.
|
|- style="background-color:#CCFFFF;"
|6348411
| [[Panel class/DistributeSelection method|DistributeSelection]]
|Distributes selected objects.
|
|- style="background-color:#CCFFFF;"
|6348403
| [[Panel class/Make Selection method|Make Selection]]
|Selects the front panel objects you specify in <b>Objects</b> and deselects all other front panel objects.
|
|- style="background-color:#CCFFFF;"
|634840E
| [[Panel class/MoveSelectionBackward method|MoveSelectionBackward]]
|Moves the selected object(s) one step backward in the z-plane order.
|
|- style="background-color:#CCFFFF;"
|634840D
| [[Panel class/MoveSelectionForward method|MoveSelectionForward]]
|Moves the selected object(s) one step forward in the z-plane order.
|
|- style="background-color:#CCFFFF;"
|634840C
| [[Panel class/MoveSelectionToBack method|MoveSelectionToBack]]
|Converts the coordinates of a point on the screen to front panel window coordinates.
|
|- style="background-color:#CCFFFF;"
|634840B
| [[Panel class/MoveSelectionToFront method|MoveSelectionToFront]]
|Converts the coordinates of a point on the front panel window to screen coordinates.
|
|- style="background-color:#CCFFFF;"
|6348404
| [[Panel class/Select All method|Select All]]
|Selects all objects in the panel.
|
|- style="background-color:#CCFFFF;"
|6348400
| [[Panel class/Set Panel Order method|Set Panel Order]]
|Specifies the order of controls in the panel.
|X
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==

Revision as of 00:49, 9 September 2019

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

This class has no children.


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

Properties

Show/Hide Panel Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Panel Properties Table
Property ID Long Name (English) Description R/W RTE
6348800ColorRead/WriteYes
6348801Controls[]Array of references to the controls and indicators on the front panel. The array contains the references in tabbing order.Read OnlyYes (Read Only)
6348802Decorations[]Array of references to the decorations on the front panel.Read OnlyYes (Read Only)
6348803All Objects[]Array of references to all the objects (controls and decorations) on the front panel.Read OnlyYes (Read Only)
6348804Selection List[]Array of references to the selected objects on the front panel.Read OnlyYes (Read Only)
6348805Defer Panel UpdatesWhen you set this property to TRUE, LabVIEW redraws any front panel objects with pending changes then defers all new requests for front panel updates. For example, controls and indicators do not redraw when you change their properties or values. If the operating system requests a redraw, such as if the window is no longer behind another window, LabVIEW redraws the front panel with the current properties instead of the original properties. If FALSE, LabVIEW immediately redraws the changed elements of the front panel.Read/WriteYes
6348806Panes[]Returns an array of references to each pane in the pane hierarchy on the panel. You can use this property with the Front Panel property to obtain a reference to a pane in another VI.Read OnlyYes
6348807Splitters[]Returns an array of references to each splitter bar in the splitter hierarchy on the panel.Read OnlyYes
6348808Text FocusRead OnlyYes
6348809Menubar VisibleRead/WriteYes

Methods

Show/Hide Panel Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Panel Methods Table
Method ID Long Name (English) Description RTE
6348400Set Panel OrderSpecifies the order of controls in the panel.Yes (Read/Write)
6348401Make SpaceYes
6348402Clear SelectionClears the selection list.No
6348403Make SelectionSelects the front panel objects you specify in Objects and deselects all other front panel objects.No
6348404Select AllSelects all objects in the panel.No
6348405Copy SelectionCopies objects you select into clipboard.No
6348406Paste SelectionNo
6348407Group ObjectsNo
6348408Lock ObjectsNo
6348409Ungroup ObjectsNo
634840AUnlock ObjectsNo
634840BMove Selection To FrontConverts the coordinates of a point on the front panel window to screen coordinates.No
634840CMove Selection To BackConverts the coordinates of a point on the screen to front panel window coordinates.No
634840DMove Selection ForwardMoves the selected object(s) one step forward in the z-plane order.No
634840EMove Selection BackwardMoves the selected object(s) one step backward in the z-plane order.No
634840FConvert Panel To Screen CoordinatesConverts front panel coordinates to screen coordinates.Yes (Read/Write)
6348410Convert Screen To Panel CoordinatesConverts screen coordinates to front panel coordinates.Yes (Read/Write)
6348411Distribute SelectionDistributes selected objects.No
6348412Align SelectionAligns selected objects.No

Events

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


History

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

See Also