Jump to content

MultiFrameStructure 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 MultiFrameStructure Properties Table</span>
{{VIServerClassTables|16406}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ MultiFrameStructure Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|6363803
| [[MultiFrameStructure class/FrameCount property|FrameCount]]
|Returns the number of frames in the structure.
|R
|X
|- style="background-color:#CCFFFF;"
|6363802
| [[MultiFrameStructure class/FrameSelRect property|FrameSelRect]]
|Returns the bounds of the selector label of the structure.
|R
|X
|- style="background-color:#CCFFFF;"
|6363801
| [[MultiFrameStructure class/Frames() property|Frames()]]
|Returns an array of references to the frames of the structure.
|R
|
|- style="background-color:#CCFFFF;"
|6363800
| [[MultiFrameStructure class/VisFrame property|VisFrame]]
|Returns the index to the visible frame of the structure, where 0 is the first frame.
|R/W
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide MultiFrameStructure Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ MultiFrameStructure Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|6363400
| [[MultiFrameStructure class/Add Frame method|Add Frame]]
|Adds a new frame before or after the frame whose index you specify and returns a reference to the new frame.
|
|- style="background-color:#CCFFFF;"
|6363402
| [[MultiFrameStructure class/Duplicate Frame method|Duplicate Frame]]
|Duplicates the frame you specify and returns a reference to the new frame.
|
|- style="background-color:#CCFFFF;"
|6363404
| [[MultiFrameStructure class/RearrangeFrames method|RearrangeFrames]]
|Rearranges the frames of the structure according to the order you specify in <b>Frame References</b>.
|X
|- style="background-color:#CCFFFF;"
|6363403
| [[MultiFrameStructure class/RearrangeFramesByIdx method|RearrangeFramesByIdx]]
|Rearranges the frames of the structure according to the order you specify in <b>Index Array</b>.
|X
|- style="background-color:#CCFFFF;"
|6363401
| [[MultiFrameStructure class/Remove Frame method|Remove Frame]]
|Removes the frame you specify. LabVIEW also removes the contents of the frame.
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==

Revision as of 00:35, 9 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name MultiFrameStructure class
Class ID 16406
Scope VI Scripting
Class Inheritance
Class Children


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

Properties

Show/Hide MultiFrameStructure Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
MultiFrameStructure Properties Table
Property ID Long Name (English) Description R/W RTE
6363800Visible FrameReturns the index to the visible frame of the structure, where 0 is the first frame.Read/WriteNo
6363801Frames[]Returns an array of references to the frames of the structure.Read OnlyNo
6363802Frame Selector RectReturns the bounds of the selector label of the structure.Read OnlyYes
6363803Frame CountReturns the number of frames in the structure.Read OnlyYes

Methods

Show/Hide MultiFrameStructure Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
MultiFrameStructure Methods Table
Method ID Long Name (English) Description RTE
6363400Add FrameAdds a new frame before or after the frame whose index you specify and returns a reference to the new frame.No
6363401Remove FrameRemoves the frame you specify. LabVIEW also removes the contents of the frame.No
6363402Duplicate FrameDuplicates the frame you specify and returns a reference to the new frame.No
6363403Rearrange Frames By IndexRearranges the frames of the structure according to the order you specify in Index Array.Yes (Read/Write)
6363404Rearrange FramesRearranges the frames of the structure according to the order you specify in Frame References.Yes (Read/Write)

Events

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


History

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

See Also