Jump to content

ConnectorPane class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
m Removed VI Sever Category from page
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{VIServerClass|name=ConnectorPane|id=56|scope=script|class_0=Generic|class_1=ConnectorPane}}
{{VIServerClass|56}}


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


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VIServer Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide ConnectorPane Properties Table</span>
{{VIServerClassTables|56}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ ConnectorPane Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|239A8403
| [[ConnectorPane class/Ctrls() property|Ctrls()]]
|Gets the controls hooked to the connector.
|R
|X
|- style="background-color:#CCFFFF;"
|239A8402
| [[ConnectorPane class/IconVis property|IconVis]]
|Makes the icon or the connector pane visible.
|R/W
|X
|- style="background-color:#CCFFFF;"
|239A8401
| [[ConnectorPane class/NumConns property|NumConns]]
|Returns the number of connection terminals in the connector pane
|R
|X
|- style="background-color:#CCFFFF;"
|239A8400
| [[ConnectorPane class/Pattern property|Pattern]]
|Assigns or gets the connector pane pattern for a VI. Valid values are 4800 to 4835.
|R/W
|X
|- style="background-color:#CCFFFF;"
|239A8404
| [[ConnectorPane class/TermBnds() property|TermBnds()]]
|Returns an array of terminal bounds for the referenced connector pane. The bounds for each terminal are represented as a cluster of integers that indicate the position of each edge of the terminal rectangle.
 
The array elements are in terminal order as defined in the Connector Pane Pattern Reference VI for each connector pane pattern.
|R
|X
|- style="background-color:#CCFFFF;"
|239A8405
| [[ConnectorPane class/WiringRules() property|WiringRules()]]
|Sets or returns an array of the wiring rules for each terminal on a connector pane.
|R/W
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide ConnectorPane Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ ConnectorPane Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|239A8000
| [[ConnectorPane class/AssignCtrlToTerm method|AssignCtrlToTerm]]
|Assigns a front panel control to a connector pane terminal of the VI.
 
You can use this method to configure the connector panes of a target VI using VI Scripting.
|
|- style="background-color:#CCFFFF;"
|239A8003
| [[ConnectorPane class/DiscAllTerms method|DiscAllTerms]]
|Disconnects all connector pane terminals from controls and indicators.
|
|- style="background-color:#CCFFFF;"
|239A8002
| [[ConnectorPane class/DiscTerm method|DiscTerm]]
|Disconnects a connector pane terminal from a control or an indicator.
|
|- style="background-color:#CCFFFF;"
|239A8005
| [[ConnectorPane class/FlipHoriz method|FlipHoriz]]
|Flips the connector pane horizontally.
|
|- style="background-color:#CCFFFF;"
|239A8006
| [[ConnectorPane class/FlipVert method|FlipVert]]
|Flips the connector pane vertically.
|
|- style="background-color:#CCFFFF;"
|239A8004
| [[ConnectorPane class/Rot90 method|Rot90]]
|Rotates the connector pane counter-clockwise by 90 degrees.
|
|- style="background-color:#CCFFFF;"
|239A8007
| [[ConnectorPane class/GetWiringRule method|GetWiringRule]]
|Gets the wiring properties of a connector pane terminal.
 
Possible values include Invalid Wire Rule, Required, Recommended, Optional, and Dynamic Dispatch.
|
|- style="background-color:#CCFFFF;"
|239A8001
| [[ConnectorPane class/SetWireRule method|SetWireRule]]
|Sets the wiring properties of a connector pane terminal.
|
|}
</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
Line 134: Line 25:
*[[VI Scripting]]
*[[VI Scripting]]


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

Latest revision as of 01:44, 8 May 2020

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

Properties

Show/Hide ConnectorPane Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
ConnectorPane Properties Table
Property ID Long Name (English) Description R/W RTE
239A8400PatternAssigns or gets the connector pane pattern for a VI. Valid values are 4800 to 4835.Read/WriteYes
239A8401Number of Connection TerminalsReturns the number of connection terminals in the connector paneRead OnlyYes
239A8402Icon VisibleMakes the icon or the connector pane visible.Read/WriteYes (Read Only)
239A8403Controls[]Gets the controls hooked to the connector.Read OnlyYes (Read Only)
239A8404Terminal Bounds[]Returns an array of terminal bounds for the referenced connector pane. The bounds for each terminal are represented as a cluster of integers that indicate the position of each edge of the terminal rectangle.Read OnlyYes (Read Only)
239A8405WiringRules[]Sets or returns an array of the wiring rules for each terminal on a connector pane.Read/WriteNo

Methods

Show/Hide ConnectorPane Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
ConnectorPane Methods Table
Method ID Long Name (English) Description RTE
239A8000Assign Control To TerminalAssigns a front panel control to a connector pane terminal of the VI.No
239A8001Wiring Rule:SetSets the wiring properties of a connector pane terminal.No
239A8002Disconnect TerminalDisconnects a connector pane terminal from a control or an indicator.No
239A8003Disconnect All TerminalsDisconnects all connector pane terminals from controls and indicators.No
239A8004Rotate By 90Rotates the connector pane counter-clockwise by 90 degrees.No
239A8005Flip HorizontalFlips the connector pane horizontally.No
239A8006Flip VerticalFlips the connector pane vertically.No
239A8007Wiring Rule:GetGets the wiring properties of a connector pane terminal.No

Events

This class has no events or it inherits events from its parent: Generic 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=ConnectorPane_class&oldid=26555"