Jump to content

DisableStructure class: Difference between revisions

From LabVIEW Wiki
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 DisableStructure Properties Table</span>
{{VIServerClassTables|16487}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ DisableStructure Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|669BE402
| [[DisableStructure class/ActiveFrame property|ActiveFrame]]
|Returns the index of the Conditional Disable structure subdiagram that is currently active, or the subdiagram whose conditions the block diagram code meets.
|R/W
|X
|- style="background-color:#CCFFFF;"
|669BE401
| [[DisableStructure class/Conditions property|Conditions]]
|Gets or sets an array of the strings that define the condition for each Conditional Disable structure subdiagram.
|R/W
|X
|- style="background-color:#CCFFFF;"
|669BE400
| [[DisableStructure class/DefaultFrame property|DefaultFrame]]
|Gets or sets the index of the default subdiagram of a Conditional Disable structure.
|R/W
|X
|- style="background-color:#CCFFFF;"
|669BE403
| [[DisableStructure class/Disable Style property|Disable Style]]
|
|R
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide DisableStructure Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ DisableStructure Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|669BE002
| [[DisableStructure class/Change Disable Style method|Change Disable Style]]
|Changes a Diagram Disable structure to a Conditional Disable structure, and vice versa.
|X
|- style="background-color:#CCFFFF;"
|669BE000
| [[DisableStructure class/Get Frame Index method|Get Frame Index]]
|Returns the index of the Conditional Disable structure subdiagram whose <b>Condition</b> matches the string you specify.
|X
|- style="background-color:#CCFFFF;"
|669BE001
| [[DisableStructure class/Remove Empty Frames method|Remove Empty Frames]]
|Removes any empty subdiagrams from the Conditional Disable structure you specify.
|X
|}
</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 DisableStructure class
Class ID 16487
Scope VI Scripting
Class Inheritance
Class Children

This class has no children.


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

Properties

Show/Hide DisableStructure Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
DisableStructure Properties Table
Property ID Long Name (English) Description R/W RTE
669BE400Default FrameGets or sets the index of the default subdiagram of a Conditional Disable structure.Read/WriteYes
669BE401ConditionsGets or sets an array of the strings that define the condition for each Conditional Disable structure subdiagram.Read/WriteYes
669BE402Active FrameReturns the index of the Conditional Disable structure subdiagram that is currently active, or the subdiagram whose conditions the block diagram code meets.Read/WriteYes
669BE403Disable StyleRead OnlyNo

Methods

Show/Hide DisableStructure Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
DisableStructure Methods Table
Method ID Long Name (English) Description RTE
669BE000Get Frame IndexReturns the index of the Conditional Disable structure subdiagram whose Condition matches the string you specify.Yes (Read/Write)
669BE001Remove Empty FramesRemoves any empty subdiagrams from the Conditional Disable structure you specify.Yes (Read/Write)
669BE002Change Disable StyleChanges a Diagram Disable structure to a Conditional Disable structure, and vice versa.Yes (Read/Write)

Events

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


History

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

See Also