Jump to content

SubPanel class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
VisualWikitext
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 SubPanel Properties Table</span>
{{VIServerClassTables|65}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ SubPanel Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|72584008
| [[SubPanel class/AllowOpenBD property|AllowOpenBD]]
|If TRUE, displays an <b>Open Block Diagram</b> item on the shortcut menu when the user right-clicks on the border of a subpanel control in a running VI or within the border of a subpanel control but not on a control or indicator on the front panel loaded in a subpanel control in a running VI. If FALSE, the <b>Open Block Diagram</b> menu item does not appear.
 
This property is similar to the Allow User to Open Diagram item on the shortcut menu of a subpanel control.
|R/W
|X
|- style="background-color:#D1BB80;"
|7258400E
| [[SubPanel class/AllowObjectDragAndDrop property|AllowObjectDragAndDrop]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|7258400B
| [[SubPanel class/AllowRTEdits property|AllowRTEdits]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|72584003
| [[SubPanel class/ContainerBounds property|ContainerBounds]]
|Size of the area in the subpanel control that contains the front panel.
|R/W
|X
|- style="background-color:#FFFFCC;"
|72584005
| [[SubPanel class/Height property|Height]]
|Height of the area in the subpanel control that contains the front panel.
 
This property is an element of the Container Bounds property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|72584004
| [[SubPanel class/Width property|Width]]
|Width of the area in the subpanel control that contains the front panel.
 
This property is an element of the Container Bounds property.
|R/W
|X
|- style="background-color:#CCFFFF;"
|7258400D
| [[SubPanel class/DiagramInserted property|DiagramInserted]]
|Specifies whether to insert a diagram in the subpanel instead of the front panel.
|R
|X
|- style="background-color:#FFFFCC;"
|7258400F
| [[SubPanel class/InsertedVI property|InsertedVI]]
|Returns a reference to the VI currently loaded in the referenced subpanel control.
|R
|X
|- style="background-color:#CCFFFF;"
|7258400C
| [[SubPanel class/Origin property|Origin]]
|Returns the scroll origin of the hosted panel.
|R/W
|X
|- style="background-color:#FFFFCC;"
|72584002
| [[SubPanel class/PanelTransparent property|PanelTransparent]]
|If TRUE, LabVIEW draws the background of the front panel in the subpanel control as transparent. If FALSE, LabVIEW draws the background color of the front panel.
 
This property is similar to the Make Panel Transparent item on the shortcut menu of a subpanel control.
|R/W
|X
|- style="background-color:#D1BB80;"
|72584009
| [[SubPanel class/Value property|Value]]
|
|R/W
|X
|- style="background-color:#D1BB80;"
|7258400A
| [[SubPanel class/Val(Sgnl) property|Val(Sgnl)]]
|
|W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide SubPanel Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ SubPanel Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#D1BB80;"
|72583C03
| [[SubPanel class/Insert Remote VI method|Insert Remote VI]]
|
|X
|- style="background-color:#FFFFCC;"
|72583C00
| [[SubPanel class/Insert VI method|Insert VI]]
|Loads a VI in the subpanel control without changing the state of the VI.
 
If the front panel of the VI you want to load is open or if you loaded the front panel in another subpanel control on the same front panel, LabVIEW returns an error, and you cannot load the front panel in the subpanel control unless the front panel is reentrant. You also cannot load the front panel of a VI in a remote application instance, and you cannot load front panels recursively.
|X
|- style="background-color:#CCFFFF;"
|72583C02
| [[SubPanel class/InsertBD method|InsertBD]]
|Inserts the VI block diagram into the subpanel
|X
|- style="background-color:#FFFFCC;"
|72583C01
| [[SubPanel class/Remove VI method|Remove VI]]
|Unloads the VI in the subpanel control. If no references to the VI remain, LabVIEW removes the VI from memory. If references to the VI remain and the VI stays in memory, this method does not change the state of the VI.
|X
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==

Revision as of 22:38, 8 September 2019

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

Properties

Show/Hide SubPanel Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
SubPanel Properties Table
Property ID Long Name (English) Description R/W RTE
72584000Scale PanelRead/WriteYes
72584002Panel TransparentIf TRUE, LabVIEW draws the background of the front panel in the subpanel control as transparent. If FALSE, LabVIEW draws the background color of the front panel.Read/WriteYes
72584003Container BoundsSize of the area in the subpanel control that contains the front panel.Read/WriteYes
72584004Container Bounds:WidthWidth of the area in the subpanel control that contains the front panel.Read/WriteYes
72584005Container Bounds:HeightHeight of the area in the subpanel control that contains the front panel.Read/WriteYes
72584006X Scrollbar VisibleRead/WriteYes
72584007Y Scrollbar VisibleRead/WriteYes
72584008Allow User to Open DiagramIf TRUE, displays an Open Block Diagram item on the shortcut menu when the user right-clicks on the border of a subpanel control in a running VI or within the border of a subpanel control but not on a control or indicator on the front panel loaded in a subpanel control in a running VI. If FALSE, the Open Block Diagram menu item does not appear.Read/WriteYes
72584009ValueRead/WriteYes
7258400AValue (Signaling)Write OnlyYes
7258400BAllowRTEditsRead/WriteYes
7258400COriginReturns the scroll origin of the hosted panel.Read/WriteYes
7258400DDiagram InsertedSpecifies whether to insert a diagram in the subpanel instead of the front panel.Read OnlyYes
7258400EAllowObjectDragAndDropRead/WriteYes
7258400FInserted VIReturns a reference to the VI currently loaded in the referenced subpanel control.Read OnlyYes

Methods

Show/Hide SubPanel Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
SubPanel Methods Table
Method ID Long Name (English) Description RTE
72583C00Insert VILoads a VI in the subpanel control without changing the state of the VI.Yes (Read/Write)
72583C01Remove VIUnloads the VI in the subpanel control. If no references to the VI remain, LabVIEW removes the VI from memory. If references to the VI remain and the VI stays in memory, this method does not change the state of the VI.Yes (Read/Write)
72583C02InsertBlockDiagramInserts the VI block diagram into the subpanelYes (Read/Write)
72583C03Insert Remote VIYes

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=SubPanel_class&oldid=9801"