Jump to content

TopLevelDiagram class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
VisualWikitext
mNo edit summary
Replaced with template tables
Line 8: Line 8:


==Properties==
==Properties==
<span class="mw-customtoggle-propertiestable">Show/Hide TopLevelDiagram Properties Table</span>
{{VIServerPropsTable|16423}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ TopLevelDiagram Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|6349402
| [[TopLevelDiagram class/Button Bar Vis property|Button Bar Vis]]
|Shows or hides the button bar on the block diagram.
|R/W
|X
|- style="background-color:#D1BB80;"
|6349406
| [[TopLevelDiagram class/DeferDiagUpdates property|DeferDiagUpdates]]
|
|R/W
|X
|- style="background-color:#CCFFFF;"
|6349404
| [[TopLevelDiagram class/HighlightObj property|HighlightObj]]
|Returns a reference to the execution highlighted object.
|R
|X
|- style="background-color:#CCFFFF;"
|6349403
| [[TopLevelDiagram class/Highlight? property|Highlight?]]
|Enables or disables execution highlighting on the block diagram.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6349401
| [[TopLevelDiagram class/Menu Vis property|Menu Vis]]
|Shows or hides the menubar on the block diagram.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6349400
| [[TopLevelDiagram class/SelList() property|SelList()]]
|Array of references to the selected objects in the diagram.
|R
|
|- style="background-color:#D1BB80;"
|6349405
| [[TopLevelDiagram class/Focus property|Focus]]
|
|R
|X
|}
</div>


==Methods==
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide TopLevelDiagram Methods Table</span>
{{VIServerMethodsTable|16423}}
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ TopLevelDiagram Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|6349006
| [[TopLevelDiagram class/AlignSelection method|AlignSelection]]
|Aligns selected objects.
|X
|- style="background-color:#CCFFFF;"
|6349001
| [[TopLevelDiagram class/Clear Selection method|Clear Selection]]
|Clears the selection list.
|
|- style="background-color:#CCFFFF;"
|6349003
| [[TopLevelDiagram class/Copy Selection method|Copy Selection]]
|Copies selected objects into the clipboard.
|
|- style="background-color:#CCFFFF;"
|6349004
| [[TopLevelDiagram class/CutSelection method|CutSelection]]
|Deletes selected objects.
|X
|- style="background-color:#CCFFFF;"
|6349007
| [[TopLevelDiagram class/DistributeSelection method|DistributeSelection]]
|Distributes selected objects.
|X
|- style="background-color:#CCFFFF;"
|6349010
| [[TopLevelDiagram class/EncloseSelection2 method|EncloseSelection2]]
|Encloses the selected items on the block diagram in a structure. When you use this property to drop a loop, LabVIEW creates tunnels with as few broken wires as possible and creates shift register pairs if appropriate.
|X
|- style="background-color:#CCFFFF;"
|6349011
| [[TopLevelDiagram class/ExternalEditorWizard method|ExternalEditorWizard]]
|
|X
|- style="background-color:#CCFFFF;"
|6349002
| [[TopLevelDiagram class/Make Selection method|Make Selection]]
|Selects the block diagram objects you specify and deselects all other block diagram objects.
|
|- style="background-color:#CCFFFF;"
|6349005
| [[TopLevelDiagram class/MakeSelectionFromRect method|MakeSelectionFromRect]]
|Allows the user to select all objects in a given area of the block diagram.
|X
|- style="background-color:#CCFFFF;"
|634900F
| [[TopLevelDiagram class/Move Selected Objects method|Move Selected Objects]]
|Moves the selected objects within this TopLevelDiagram by the number of pixels specified in <b>X/Y Delta</b>. This method simulates a mouse drag, and it has the same side effects associated with mouse-dragging in the development environment, including resizing an owner to contain the dragged objects, altering the selection list to include objects duplicated by the drag, and forcing a duplicate-drag when moving objects to another block diagram.
|X
|- style="background-color:#CCFFFF;"
|634900B
| [[TopLevelDiagram class/MoveSelectionBackward method|MoveSelectionBackward]]
|Moves the selected object(s) one step back in the z-plane order.
|X
|- style="background-color:#CCFFFF;"
|634900A
| [[TopLevelDiagram class/MoveSelectionForward method|MoveSelectionForward]]
|Moves the selected object(s) one step forward in the z-plane order.
|X
|- style="background-color:#CCFFFF;"
|6349009
| [[TopLevelDiagram class/MoveSelectionToBack method|MoveSelectionToBack]]
|Moves the selected objects to the back of the z-plane order.
|X
|- style="background-color:#CCFFFF;"
|6349008
| [[TopLevelDiagram class/MoveSelectionToFront method|MoveSelectionToFront]]
|Moves the selected objects to the front of the z-plane order.
|X
|- style="background-color:#D1BB80;"
|634900E
| [[TopLevelDiagram class/NewVIFromSelection method|NewVIFromSelection]]
|
|X
|- style="background-color:#CCFFFF;"
|634900C
| [[TopLevelDiagram class/RemoveFromSelection method|RemoveFromSelection]]
|Removes a selected set of objects from the selection list.
|
|}
</div>


==Events==
==Events==
''No Events for this class.''
{{VIServerEventsTable|16423}}


== 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 17:17, 8 September 2019

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

Properties

Show/Hide TopLevelDiagram Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
TopLevelDiagram Properties Table
Property ID Long Name (English) Description R/W RTE
6349400Selection List[]Array of references to the selected objects in the diagram.Read OnlyNo
6349401Menubar VisibleShows or hides the menubar on the block diagram.Read/WriteYes
6349402Button Bar VisibleShows or hides the button bar on the block diagram.Read/WriteYes
6349403Highlight Execution?Enables or disables execution highlighting on the block diagram.Read/WriteYes
6349404Execution Highlighted ObjectReturns a reference to the execution highlighted object.Read OnlyYes
6349405Text FocusRead OnlyYes
6349406Defer Diagram UpdatesRead/WriteYes


Methods

Show/Hide TopLevelDiagram Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
TopLevelDiagram Methods Table
Method ID Long Name (English) Description RTE
6349001Clear SelectionClears the selection list.No
6349002Make SelectionSelects the block diagram objects you specify and deselects all other block diagram objects.No
6349003Copy SelectionCopies selected objects into the clipboard.No
6349004Cut SelectionDeletes selected objects.Yes (Read/Write)
6349005Make Selection From RectAllows the user to select all objects in a given area of the block diagram.Yes (Read/Write)
6349006Align SelectionAligns selected objects.Yes (Read/Write)
6349007Distribute SelectionDistributes selected objects.Yes (Read/Write)
6349008Move Selection To FrontMoves the selected objects to the front of the z-plane order.Yes (Read/Write)
6349009Move Selection To BackMoves the selected objects to the back of the z-plane order.Yes (Read/Write)
634900AMove Selection ForwardMoves the selected object(s) one step forward in the z-plane order.Yes (Read/Write)
634900BMove Selection BackwardMoves the selected object(s) one step back in the z-plane order.Yes (Read/Write)
634900CRemoveFromSelectionRemoves a selected set of objects from the selection list.No
634900DEnclose SelectionYes
634900ENewVIFromSelectionYes
634900FMove Selected ObjectsMoves the selected objects within this TopLevelDiagram by the number of pixels specified in X/Y Delta. This method simulates a mouse drag, and it has the same side effects associated with mouse-dragging in the development environment, including resizing an owner to contain the dragged objects, altering the selection list to include objects duplicated by the drag, and forcing a duplicate-drag when moving objects to another block diagram.Yes (Read/Write)
6349010Enclose Selection 2Encloses the selected items on the block diagram in a structure. When you use this property to drop a loop, LabVIEW creates tunnels with as few broken wires as possible and creates shift register pairs if appropriate.Yes (Read/Write)
6349011External Editor WizardYes


Events

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