Template:VIServerEventsTable

From LabVIEW Wiki
Jump to: navigation, search


Usage

This template contains a lookup table for all of the events. It is used in the VI Server Class Hierarchy class pages to display the events tables. The parameter is the Class ID number where the list is then filtered to events of that class if it has any. If the parameter is left blank, the default is that it has no events.

Syntax

{{VIServerEventsTable|{{{1}}}}}

where:

Parameter Description Default
{{{1}}} The class ID. Blank - Translates into message: This class has no events.

Example: No Events Exists

No events exist for the LVVariant Class.

{{VIServerEventsTable|10}}

Result

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


Example: Events Exist

Events exist for the Control Class.

{{VIServerEventsTable|6}}

Results

Show/Hide Control Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
Control Events Table
Code Name Description Type
1073741869Drag EndedGenerated after a drag and drop operation completes.Notify
2684354617Drag EnterGenerated when there is a drag operation pending and the cursor enters the bounds of a control.Notify
1073741885Drag LeaveGenerated when there is a drag operation pending and the mouse leaves a control that can accept a drag, or if a user cancels a drag and drop operation when hovering over a control.Notify
2684354618Drag OverGenerated when there is a drag and drop operation pending, as the mouse moves over a control.Notify
2684354606Drag Source UpdateGenerated when the mouse moves or a key state changes during a drag and drop operation.Notify
1073741867Drag Starting
2147483692Drag Starting?
2684354622DropGenerated when the user lifts the mouse when hovering over a control when there is a drag and drop operation pending.Notify
1073741847Key DownGenerated on a control that has keyboard focus. If a key press matches a keyboard shortcut in the VI menu, such as Ctrl-C or Ctrl-V, LabVIEW does not generate a Key Down event, regardless of whether the menu item is enabled. Key Down Event Caveats
  • (Windows) F3 generates a Key Down event only in the LabVIEW Run-Time Engine.
  • LabVIEW only generates events for the Cluster»All Elements source when the cluster has keyboard focus, not when an individual element inside the cluster has keyboard focus.
Notify
2147483658Key Down?Generated on a control that has keyboard focus. If a key press matches a keyboard shortcut in the VI menu, such as Ctrl-C or Ctrl-V, LabVIEW does not generate a Key Down event, regardless of whether the menu item is enabled.Filter
1073741848Key RepeatGenerated at regular intervals when the user presses and holds a key in a front panel control.Notify
2147483659Key Repeat?Generated when the user presses and holds a key in a front panel control.Filter
1073741836Key UpGenerated when the user releases a key on the keyboard in a specific control on the front panel.Notify
1073741842Mouse DownGenerated when you click the mouse button on a specific control.Notify
2147483655Mouse Down?Generated when you click the mouse button on a specific control.Filter
1073741839Mouse EnterGenerated when the cursor enters the bounds of the front panel object.Notify
1073741838Mouse LeaveGenerated when the cursor leaves the bounds of the front panel object.Notify
1073741833Mouse MoveGenerated when you move the mouse over a control.Notify
1073741832Mouse UpGenerated when you release the mouse button on a specific control. LabVIEW does not generate this event if a shortcut menu appears when you click the mouse button.Notify
1073741905Mouse WheelGenerated when you scroll the mouse wheel over a control.Notify
2147483699Shortcut Menu Activation?Generated when the user right-clicks a control to display the shortcut menu.Filter
1073741892Shortcut Menu Dismissed
2147483701Shortcut Menu Selection? (App)Generated when the user selects an application item from the shortcut menu. This event is posted before the application item is processed by LabVIEW.Filter
1073741878Shortcut Menu Selection (App)Generated when the user selects an application item from the shortcut menu of a control. Use the Shortcut Menu Selection (User) event to generate an event when the user selects a user-defined menu item. This event is posted after the built-in shortcut menu item is processed by LabVIEW.Notify
1073741876Shortcut Menu Selection (User)Generated when the user selects a user-defined item from the shortcut menu. Use the Shortcut Menu Selection (App) event to generate an event when the user selects an application item from the shortcut menu.Notify
1073741826Value ChangeGenerated when the user changes the value of a control. You must read the terminal of a latched Boolean control in its Value Change event case.Notify


Example: Passing a null value

Passing a null value defaults to no events.

{{VIServerEventsTable}}

Results

This class has no events.


See Also