Table Of Contents

General User Interface Event Reference

Last Modified: February 27, 2020

The following events occur when the user performs an action that involves the panel or any control on the panel.

Event Description Event Data Fields
Close

Occurs when the user tries to interactively close a VI that is running in window mode or as a built application.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Window Reference—Reference to the window being closed.
Close?

Occurs when the user tries to interactively close a VI that is running in window mode or as a built application.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Window Reference—Reference to the window being closed.
  • Discard?—Allows you to prevent LabVIEW NXG from processing the event and bypasses the behavior normally triggered by that event.
Key Down

Occurs on a control with keyboard focus. If a key press matches a keyboard shortcut, such as <Ctrl-C> or <Ctrl-V>, the software does not generate a Key Down event, regardless of whether the menu item is enabled.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Char—Value of a character that corresponds to the key pressed on the keyboard.
  • Virtual Key—Enumerated type indicating the virtual key code of the key pressed. Values include ASCII, Shift, NumLock, F1, and so on.
  • Scan Code—Scan code unique for each key on the keyboard. The values are unique for each physical key.
  • Modifiers—Cluster of Booleans that contain platform-independent modifiers. LabVIEW NXG returns all platform-independent modifiers in the Platform Modifiers event data field.
  • Platform Modifiers—Cluster of Booleans that contain platform-dependent modifiers and specifies if platform-dependent keys, such as <Ctrl>, <Shift>, <Alt>, <Command>, and <Option> were held down when the event was triggered. For filter events, you can modify the data returned by this event data field. A key can also be both a Modifier and a Platform Modifier.
  • IsRepeat?—Indicates whether the user pressed a key or held a key down.
  • Focus Ref—A reference to the object that has keyboard focus.
Key Down?

Occurs on a control with keyboard focus. If a key press matches a keyboard shortcut, such as <Ctrl-C> or <Ctrl-V>, the software does not generate a Key Down event, regardless of whether the menu item is enabled.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Char—Value of a character that corresponds to the key pressed on the keyboard.
  • Virtual Key—Enumerated type indicating the virtual key code of the key pressed. Values include ASCII, Shift, NumLock, F1, and so on.
  • Scan Code—Scan code unique for each key on the keyboard. The values are unique for each physical key.
  • Modifiers—Cluster of Booleans that contain platform-independent modifiers. LabVIEW NXG returns all platform-independent modifiers in the Platform Modifiers event data field.
  • Platform Modifiers—Cluster of Booleans that contain platform-dependent modifiers and specifies if platform-dependent keys, such as <Ctrl>, <Shift>, <Alt>, <Command>, and <Option> were held down when the event was triggered. For filter events, you can modify the data returned by this event data field. A key can also be both a Modifier and a Platform Modifier.
  • IsRepeat?—Indicates whether the user pressed a key or held a key down.
  • Focus Ref—A reference to the object that has keyboard focus.
  • Discard?—Allows you to prevent LabVIEW NXG from processing the event and bypasses the behavior normally triggered by that event.
Key Up

Occurs when the user releases a key on the keyboard in a specific control on the panel.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Scan Code—Scan code unique for each key on the keyboard. The values are unique for each physical key.
  • Modifiers—Cluster of Booleans that contain platform-independent modifiers. LabVIEW NXG returns all platform-independent modifiers in the Platform Modifiers event data field.
  • Platform Modifiers—Cluster of Booleans that contain platform-dependent modifiers and specifies if platform-dependent keys, such as <Ctrl>, <Shift>, <Alt>, <Command>, and <Option> were held down when the event was triggered. For filter events, you can modify the data returned by this event data field. A key can also be both a Modifier and Platform Modifier.
  • Focus Ref—A reference to the object that has keyboard focus.
Mouse Down

Occurs when the user clicks the mouse button on a specific control.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Control or Panel Reference—Reference to the control or panel on which the event occurred. This event data field reads either Control or Panel Reference depending on whether the event is set on a control or panel.
  • Position—Position of the mouse at the time of the event. Position is relative to the origin of the panel.
  • Button—Value that corresponds to which mouse button the user clicked. The left mouse button is 1, and the right mouse button is 2. Operating systems may assign higher numbers if you have a mouse with more than two buttons.
  • Modifiers—Cluster of Booleans that contain platform-independent modifiers. LabVIEW NXG returns all platform-independent modifiers in the Platform Modifiers event data field.
  • Platform Modifiers—Cluster of Booleans that contain platform-dependent modifiers and specifies if platform-dependent keys, such as <Ctrl>, <Shift>, <Alt>, <Command>, and <Option> were held down when the event was triggered. For filter events, you can modify the data returned by this event data field. A key can also be both a Modifier and Platform Modifier.
Mouse Down?

Occurs when the user clicks the mouse button on a specific control.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Control or Panel Reference—Reference to the control or panel on which the event occurred. This event data field reads either Control or Panel Reference depending on whether the event is set on a control or panel.
  • Position—Position of the mouse at the time of the event. Position is relative to the origin of the panel.
  • Button—Value that corresponds to which mouse button the user clicked. The left mouse button is 1, and the right mouse button is 2. Operating systems may assign higher numbers if you have a mouse with more than two buttons.
  • Modifiers—Cluster of Booleans that contain platform-independent modifiers. LabVIEW NXG returns all platform-independent modifiers in the Platform Modifiers event data field.
  • Platform Modifiers—Cluster of Booleans that contain platform-dependent modifiers and specifies if platform-dependent keys, such as <Ctrl>, <Shift>, <Alt>, <Command>, and <Option> were held down when the event was triggered. For filter events, you can modify the data returned by this event data field. A key can also be both a Modifier and Platform Modifier.
  • Discard?—Allows you to prevent LabVIEW NXG from processing the event and bypasses the behavior normally triggered by that event.
Mouse Up?

Occurs when the user releases the mouse button on a specific control. The software does not generate this event if a shortcut menu appears when the user clicks the mouse button.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Control or Panel Reference—Reference to the control or panel on which the event occurred. This event data field reads either Control or Panel Reference depending on whether the event is set on a control or panel.
  • Position—Position of the mouse at the time of the event. Position is relative to the origin of the panel.
  • Button—Value that corresponds to which mouse button the user clicked. The left mouse button is 1, and the right mouse button is 2. Operating systems may assign higher numbers if you have a mouse with more than two buttons. For filter events, you can modify the data returned by this event data field.
  • Modifiers—Cluster of Booleans that contain platform-independent modifiers. LabVIEW NXG returns all platform-independent modifiers in the Platform Modifiers event data field.
  • Platform Modifiers—Cluster of Booleans that contain platform-dependent modifiers and specifies if platform-dependent keys, such as <Ctrl>, <Shift>, <Alt>, <Command>, and <Option> were held down when the event was triggered. For filter events, you can modify the data returned by this event data field. A key can also be both a Modifier and Platform Modifier.
Mouse Enter

Occurs when the cursor enters the bounds of the panel object.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Control or Panel Reference—Reference to the control or panel on which the event occurred. This event data field reads either Control or Panel Reference depending on whether the event is set on a control or panel.
Mouse Leave

Occurs when the cursor leaves the bounds of the panel object.

  • Index—Index of the event source within an individual event diagram.
  • Time— Value of the millisecond timer when the event occurred.
  • Control or Panel Reference—Reference to the control or panel on which the event occurred. This event data field reads either Control or Panel Reference depending on whether the event is set on a control or panel.
Mouse Wheel

Occurs when the user scrolls the mouse wheel over an object.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Control or Panel Reference—Reference to the control or panel on which the event occurred. This event data field reads either Control or Panel Reference depending on whether the event is set on a control or panel.
  • Position—Position of the mouse at the time of the event. Position is relative to the origin of the panel.
  • Delta—The distance the mouse wheel moved.
  • Orientation—Value that corresponds to the orientation of the scroll bar and indicates whether the user initiated this event on a horizontal or vertical scroll bar.
  • Button Modifiers—Cluster of Booleans that correspond to the mouse button(s) the user pressed and held during the mouse wheel movement. The Booleans indicate whether the user pressed the left, right, or middle button(s).
  • Modifiers—Cluster of Booleans that contain platform-independent modifiers. LabVIEW NXG returns all platform-independent modifiers in the Platform Modifiers event data field.
  • Platform Modifiers—Cluster of Booleans that contain platform-dependent modifiers and specifies if platform-dependent keys, such as <Ctrl>, <Shift>, <Alt>, <Command>, and <Option> were held down when the event was triggered. For filter events, you can modify the data returned by this event data field. A key can also be both a Modifier and Platform Modifier.
Value Changed

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.

spd-note-note
Note

This event is supported in VIs that run in a web application.

  • Index—Index of the event source within an individual event diagram.
  • Time—Value of the millisecond timer when the event occurred.
  • Control Reference—Reference to the control on which the event occurred.
  • Old Value—Value of the control before the data change.
  • New Value—Value of the control after the data change.

Recently Viewed Topics