Jump to content

EventStructure class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
m Removed VI Server Category from page
 
(4 intermediate revisions by the same user not shown)
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 EventStructure Properties Table</span>
{{VIServerClassTables|16458}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ EventStructure Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|5191C02
| [[EventStructure class/DynamicTerminalLeft property|DynamicTerminalLeft]]
|Gets a reference to the dynamic terminal on the left side of the Event structure.
|R
|
|- style="background-color:#CCFFFF;"
|5191C03
| [[EventStructure class/DynamicTerminalRight property|DynamicTerminalRight]]
|Gets a reference to the dynamic terminal on the right side of the Event structure.
|R
|
|- style="background-color:#CCFFFF;"
|5191C00
| [[EventStructure class/DynamicTermsVisible? property|DynamicTermsVisible?]]
|Sets whether the Event structure dynamic terminals are visible.
|R/W
|
|- style="background-color:#CCFFFF;"
|5191C05
| [[EventStructure class/EventSelectors property|EventSelectors]]
|Gets the human-readable names of the Event structure cases.
|R
|
|- style="background-color:#CCFFFF;"
|5191C04
| [[EventStructure class/NumEventFrames property|NumEventFrames]]
|Gets the number of subdiagrams, or event cases, owned by the Event structure.
|R
|
|- style="background-color:#CCFFFF;"
|5191C01
| [[EventStructure class/TimeoutTerminal property|TimeoutTerminal]]
|Gets a reference to the Timeout terminal of the Event structure.
|R
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide EventStructure Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ EventStructure Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|5191800
| [[EventStructure class/GetEventDataNode method|GetEventDataNode]]
|Gets a reference to the Event Data Node on the Event structure at the given event case index.
 
The Event Data Node identifies the data LabVIEW returns when an event occurs.
|
|- style="background-color:#CCFFFF;"
|5191801
| [[EventStructure class/GetEventFilterNode method|GetEventFilterNode]]
|Gets a reference to the Event Filter Node on the Event structure at the given event case index. If the event case handles a notify event, this property returns a NULL reference.
 
The Event Filter Node identifies the event data you can modify before the user interface can process that data.
|
|- style="background-color:#CCFFFF;"
|5191802
| [[EventStructure class/GetHandledEvents method|GetHandledEvents]]
|Gets all events configured for a given frame, or event case, to handle. This method returns the events in separate outputs grouped by registration type and refnum class.
|
|- style="background-color:#D1BB80;"
|5191804
| [[EventStructure class/GetHandledEventsPriv method|GetHandledEventsPriv]]
|
|
|- style="background-color:#CCFFFF;"
|5191803
| [[EventStructure class/SetHandledEvents method|SetHandledEvents]]
|Sets all events configured for the given the frame, or event case, to handle.
|
|- style="background-color:#D1BB80;"
|5191805
| [[EventStructure class/SetHandledEventsPriv method|SetHandledEventsPriv]]
|
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
Line 118: Line 21:


== See Also ==
== See Also ==
*[[Functions Palette/Programming/Structures/Event Structure|Event 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 EventStructure class
Class ID 16458
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 EventStructure class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide EventStructure Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
EventStructure Properties Table
Property ID Long Name (English) Description R/W RTE
5191C00Dynamic Terminals Visible?Sets whether the Event structure dynamic terminals are visible.Read/WriteNo
5191C01Timeout TerminalGets a reference to the Timeout terminal of the Event structure.Read OnlyNo
5191C02Dynamic Terminal (Left)Gets a reference to the dynamic terminal on the left side of the Event structure.Read OnlyNo
5191C03Dynamic Terminal (Right)Gets a reference to the dynamic terminal on the right side of the Event structure.Read OnlyNo
5191C04Number of Event FramesGets the number of subdiagrams, or event cases, owned by the Event structure.Read OnlyNo
5191C05Event SelectorsGets the human-readable names of the Event structure cases.Read OnlyNo

Methods

Show/Hide EventStructure Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
EventStructure Methods Table
Method ID Long Name (English) Description RTE
5191800Get Event Data NodeGets a reference to the Event Data Node on the Event structure at the given event case index.No
5191801Get Event Filter NodeGets a reference to the Event Filter Node on the Event structure at the given event case index. If the event case handles a notify event, this property returns a NULL reference.No
5191802Get Handled EventsGets all events configured for a given frame, or event case, to handle. This method returns the events in separate outputs grouped by registration type and refnum class.No
5191803Set Handled EventsSets all events configured for the given the frame, or event case, to handle.No
5191804Get Handled Events (Private)No
5191805Set Handled Events (Private)No

Events

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