Jump to content

FlatSequence class: Difference between revisions

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


{{stub}}
{{stub}}
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 FlatSequence Properties Table</span>
{{VIServerClassTables|16459}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ FlatSequence Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|3578BC01
| [[FlatSequence class/AutoSize property|AutoSize]]
|Sets or returns whether the Flat Sequence structure automatically resizes to fit its contents.
|R/W
|
|- style="background-color:#CCFFFF;"
|3578BC09
| [[FlatSequence class/BreakPtStatus property|BreakPtStatus]]
|Sets or returns the status of a breakpoint on a Flat Sequence structure.
 
Valid values include Cleared Break, Enabled Break, and Disabled Break.
|R/W
|
|- style="background-color:#CCFFFF;"
|3578BC04
| [[FlatSequence class/Desc property|Desc]]
|Sets or returns the description string for the Flat Sequence structure.
|R/W
|
|- style="background-color:#CCFFFF;"
|3578BC07
| [[FlatSequence class/Frames() property|Frames()]]
|Returns an array of references to the frames of the Flat Sequence structure.
|R
|
|- style="background-color:#CCFFFF;"
|3578BC03
| [[FlatSequence class/Label property|Label]]
|References the label of the Flat Sequence structure.
|R
|
|- style="background-color:#CCFFFF;"
|3578BC0A
| [[FlatSequence class/SubDiagLbl Vis property|SubDiagLbl Vis]]
|Sets the visibility of the subdiagram label. This property is similar to the <b>Visible Items&#0187;Subdiagram Label</b> item on the shortcut menu of a structure. This property is also similar to the <b>Subdiagram label visible</b> option on the Appearance page of the Properties dialog box.
|R/W
|
|- style="background-color:#D1BB80;"
|3578BC08
| [[FlatSequence class/Target Syntax Checking property|Target Syntax Checking]]
|
|R/W
|
|- style="background-color:#CCFFFF;"
|3578BC05
| [[FlatSequence class/Terms() property|Terms()]]
|Returns an array of references to the terminals of the Flat Sequence structure.
|R
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide FlatSequence Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ FlatSequence Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|3578B800
| [[FlatSequence 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.
|X
|- style="background-color:#CCFFFF;"
|3578B802
| [[FlatSequence class/Auto Size method|Auto Size]]
|Automatically resizes the Flat Sequence structure to fit contents.
|X
|- style="background-color:#CCFFFF;"
|3578B805
| [[FlatSequence class/Convert To TimedSequence method|Convert To TimedSequence]]
|Converts the Flat Sequence structure to a Timed Sequence structure and returns a reference to the new structure.
 
This method automatically closes the reference to the original Flat Sequence structure.
|X
|- style="background-color:#CCFFFF;"
|3578B803
| [[FlatSequence class/Remove Flat Sequence method|Remove Flat Sequence]]
|Removes the Flat Sequence structure from the diagram. The contents of the structure merge with the rest of the contents of the diagram.
|X
|- style="background-color:#CCFFFF;"
|3578B801
| [[FlatSequence class/Remove Frame method|Remove Frame]]
|Removes the frame you specify. LabVIEW also removes the contents of the frame. You cannot use this method to remove the only frame of a sequence structure. Use the Delete method instead.
|X
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
Line 125: Line 21:


== See Also ==
== See Also ==
*[[Functions Palette/Programming/Structures/Flat Sequence Structure|Flat Sequence Structure]]
*[[VI Server Class Hierarchy]]
*[[VI Server Class Hierarchy]]
*[[VI Server]]
*[[VI Server]]
*[[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 02:06, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name FlatSequence class
Class ID 16459
Scope VI Scripting
Class Inheritance
Class Children


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

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

Properties

Show/Hide FlatSequence Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
FlatSequence Properties Table
Property ID Long Name (English) Description R/W RTE
3578BC00Diagrams[]Read OnlyNo
3578BC01AutoSize To Fit Contents?Sets or returns whether the Flat Sequence structure automatically resizes to fit its contents.Read/WriteNo
3578BC02Content Rects[]Read OnlyYes
3578BC03LabelReferences the label of the Flat Sequence structure.Read OnlyNo
3578BC04DescriptionSets or returns the description string for the Flat Sequence structure.Read/WriteNo
3578BC05Terminals[]Returns an array of references to the terminals of the Flat Sequence structure.Read OnlyYes
3578BC06Is Break Point SetRead/WriteYes
3578BC07Frames[]Returns an array of references to the frames of the Flat Sequence structure.Read OnlyNo
3578BC08Target Syntax CheckingRead/WriteNo
3578BC09Breakpoint StatusSets or returns the status of a breakpoint on a Flat Sequence structure.Read/WriteNo
3578BC0ASubdiagram Label VisibleSets the visibility of the subdiagram label. This property is similar to the Visible Items»Subdiagram Label item on the shortcut menu of a structure. This property is also similar to the Subdiagram label visible option on the Appearance page of the Properties dialog box.Read/WriteNo

Methods

Show/Hide FlatSequence Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
FlatSequence Methods Table
Method ID Long Name (English) Description RTE
3578B800Add FrameAdds a new frame before or after the frame whose index you specify and returns a reference to the new frame.Yes (Read/Write)
3578B801Remove FrameRemoves the frame you specify. LabVIEW also removes the contents of the frame. You cannot use this method to remove the only frame of a sequence structure. Use the Delete method instead.Yes (Read/Write)
3578B802Auto SizeAutomatically resizes the Flat Sequence structure to fit contents.Yes (Read/Write)
3578B803Remove Flat SequenceRemoves the Flat Sequence structure from the diagram. The contents of the structure merge with the rest of the contents of the diagram.Yes (Read/Write)
3578B804Size FrameYes
3578B805Convert To Timed SequenceConverts the Flat Sequence structure to a Timed Sequence structure and returns a reference to the new structure.Yes (Read/Write)

Events

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