Template:VIServerEventsTable: Difference between revisions
Created full Events lookup table |
mNo edit summary |
||
| Line 33: | Line 33: | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>2147483659</td><td>[[VI class/Key Repeat? event{{!}}Key Repeat?]]</td><td>Generated at regular intervals when the user presses and holds a key anywhere on the front panel.</td><td>Filter</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>2147483659</td><td>[[VI class/Key Repeat? event{{!}}Key Repeat?]]</td><td>Generated at regular intervals when the user presses and holds a key anywhere on the front panel.</td><td>Filter</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>1073741836</td><td>[[VI class/Key Up event{{!}}Key Up]]</td><td>Generated when the user releases a key on the keyboard.</td><td>Notify</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>1073741836</td><td>[[VI class/Key Up event{{!}}Key Up]]</td><td>Generated when the user releases a key on the keyboard.</td><td>Notify</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#D1BB80;"><td>2147483680</td><td>[[VI class/ event{{!}}]]</td><td></td><td></td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#D1BB80;"><td>2147483680</td><td>[[VI class/Menu Activation? event{{!}}]]</td><td></td><td></td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>1073741851</td><td>[[VI class/Menu Selection (App) event{{!}}Menu Selection (App)]]</td><td>Generated when the user selects an [[application item]] from the LabVIEW menu, such as '''Help»Show Context Help'''. Use the [[Menu Selection (User)]] event to generate an event when the user selects a user-defined menu item.</td><td>Notify</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>1073741851</td><td>[[VI class/Menu Selection (App) event{{!}}Menu Selection (App)]]</td><td>Generated when the user selects an [[application item]] from the LabVIEW menu, such as '''Help»Show Context Help'''. Use the [[Menu Selection (User)]] event to generate an event when the user selects a user-defined menu item.</td><td>Notify</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>2147483654</td><td>[[VI class/Menu Selection? (App) event{{!}}Menu Selection? (App)]]</td><td>Generated when the user selects an [[application item]] from the LabVIEW menu, such as '''Help»Show Context Help'''.</td><td>Filter</td></tr> | |}}{{#ifeq: {{{1|}}} | 2 | <tr style="background-color:#FFFFCC;"><td>2147483654</td><td>[[VI class/Menu Selection? (App) event{{!}}Menu Selection? (App)]]</td><td>Generated when the user selects an [[application item]] from the LabVIEW menu, such as '''Help»Show Context Help'''.</td><td>Filter</td></tr> | ||
| Line 52: | Line 52: | ||
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#D1BB80;"><td>2147483692</td><td>[[Control class/Drag Starting? event{{!}}Drag Starting?]]</td><td></td><td></td></tr> | |}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#D1BB80;"><td>2147483692</td><td>[[Control class/Drag Starting? event{{!}}Drag Starting?]]</td><td></td><td></td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>2684354622</td><td>[[Control class/Drop event{{!}}Drop]]</td><td>Generated when the user lifts the mouse when hovering over a control when there is a drag and drop operation pending.</td><td>Notify</td></tr> | |}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>2684354622</td><td>[[Control class/Drop event{{!}}Drop]]</td><td>Generated when the user lifts the mouse when hovering over a control when there is a drag and drop operation pending.</td><td>Notify</td></tr> | ||
|}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>1073741847</td><td>[[Control class/Key Down event{{!}}Key Down]]</td><td>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. | |}}{{#ifeq: {{{1|}}} | 6 | <tr style="background-color:#FFFFCC;"><td>1073741847</td><td>[[Control class/Key Down event{{!}}Key Down]]</td><td>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. '''Key Down Event Caveats''' | ||
<ul> | <ul> | ||
Revision as of 02:45, 8 September 2019
 |
This page is under construction. This page or section is currently in the middle of an expansion or major revamping. However, you are welcome to assist in its construction by editing it as well. Please view the edit history should you wish to contact the person who placed this template. If this article has not been edited in several days please remove this template. Please don't delete this page unless the page hasn't been edited in several days. While actively editing, consider adding {{inuse}} to reduce edit conflicts. |
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 either the Class ID number where the list is then filtered to events of that class, or the parameter is left blank to signify this class has no methods.
| Parameter | Description | Default |
|---|---|---|
{{{1}}}
|
The class ID. | Blank - Translates into message: No Events for this class.
|
Example: No Events Exists
{{VIServerEventsTable}}
No Events for this class.
Example: Events Exist - Application Class
{{VIServerEventsTable|1}}
Show/Hide Application Events Table
| Legend | |
|---|---|
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated |
| Code | Name | Description | Type |
|---|---|---|---|
| 1073741888 | Application Activation | Occurs when the user activates LabVIEW. | Notify |
| 1073741850 | Application Instance Close | When registered for in a VI running inside a LabVIEW project, generated when the application instance of the project is closed for any reason, such as when you close the Project Explorer window, when you select File»Close All or File»Quit, or when you run a VI that executes the Quit LabVIEW function. When registered for in a VI running outside a project, generated when you exit LabVIEW through the user interface or with the Quit LabVIEW function. | Notify |
| 2147483652 | Application Instance Close? | When registered for in a VI running inside a LabVIEW project, this event is generated when the application instance of the project is closed interactively, such as when you close the Project Explorer window or when you select File»Close All or File»Quit. When registered for in a VI running outside a project, this event is generated only when you exit LabVIEW through the user interface. | Filter |
| 1073741908 | Auto Error Notification | ||
| 1073741906 | Bookmark Info Change | Generated when the user changes a bookmark. | Notify |
| 1073741896 | Context Help Window Updated | Occurs when the Context Help window is updated. | Notify |
| 1073741883 | NI Security User Change | Generated when the user logs into the application. | Notify |
| 1073741889 | OS Open Document | ||
| 2147483717 | OS Open Document? | ||
| 1073741897 | Selection Change | ||
| 1073741825 | Timeout | Occurs when the Event structure times out. Wire a value to the Timeout terminal at the top left of the Event structure to specify the number of milliseconds the Event structure should wait for an event to occur before generating a Timeout event. | Notify |
| 1073741857 | VI Activation | Generated when you activate a VI window. | Notify |
| 1073741907 | VI Deactivation | Generated when you deactivate a VI window. This event fires when you remove focus from a VI. | Notify |
| 1073741858 | VI Redraw | ||
| 1073741859 | VI Scroll | Notify | |
| 1073741899 | Window Opened | ||
| 2147483722 | Window Opened? |
Example: Events Exist - Control Class
{{VIServerEventsTable|6}}
Show/Hide Control Events Table
| Legend | |
|---|---|
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated |
| Code | Name | Description | Type |
|---|---|---|---|
| 1073741869 | Drag Ended | Generated after a drag and drop operation completes. | Notify |
| 2684354617 | Drag Enter | Generated when there is a drag operation pending and the cursor enters the bounds of a control. | Notify |
| 1073741885 | Drag Leave | Generated 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 |
| 2684354618 | Drag Over | Generated when there is a drag and drop operation pending, as the mouse moves over a control. | Notify |
| 2684354606 | Drag Source Update | Generated when the mouse moves or a key state changes during a drag and drop operation. | Notify |
| 1073741867 | Drag Starting | ||
| 2147483692 | Drag Starting? | ||
| 2684354622 | Drop | Generated when the user lifts the mouse when hovering over a control when there is a drag and drop operation pending. | Notify |
| 1073741847 | Key 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. Key Down Event Caveats
| Notify |
| 2147483658 | Key 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 |
| 1073741848 | Key Repeat | Generated at regular intervals when the user presses and holds a key in a front panel control. | Notify |
| 2147483659 | Key Repeat? | Generated when the user presses and holds a key in a front panel control. | Filter |
| 1073741836 | Key Up | Generated when the user releases a key on the keyboard in a specific control on the front panel. | Notify |
| 1073741842 | Mouse Down | Generated when you click the mouse button on a specific control. | Notify |
| 2147483655 | Mouse Down? | Generated when you click the mouse button on a specific control. | Filter |
| 1073741839 | Mouse Enter | Generated when the cursor enters the bounds of the front panel object. | Notify |
| 1073741838 | Mouse Leave | Generated when the cursor leaves the bounds of the front panel object. | Notify |
| 1073741833 | Mouse Move | Generated when you move the mouse over a control. | Notify |
| 1073741832 | Mouse Up | Generated 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 |
| 1073741905 | Mouse Wheel | Generated when you scroll the mouse wheel over a control. | Notify |
| 2147483699 | Shortcut Menu Activation? | Generated when the user right-clicks a control to display the shortcut menu. | Filter |
| 1073741892 | Shortcut Menu Dismissed | ||
| 2147483701 | Shortcut 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 |
| 1073741878 | Shortcut 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 |
| 1073741876 | Shortcut 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 |
| 1073741826 | Value Change | Generated 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: No Events Exist - GObject Class
If events do not exist for this class, but the Class ID is still passed in, only the column headers will be seen. Instead, only pass Class ID if the class has events.
{{VIServerEventsTable|36}}
Show/Hide GObject Events Table
| Legend | |
|---|---|
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated |
| Code | Name | Description | Type |
|---|