Mouse Property

LabView Local Project Settings

Mouse Property

Short Name: Mouse

Installed With: Base Package

Class: Picture Properties

Mouse information specified as a cluster of (Mouse Position, Mouse Modifiers). Mouse Position is a cluster of (Vertical, Horizontal) coordinates. Mouse Modifiers is a cluster of (Mouse button pressed?, Shift key down?, Menu key down?, and Option key down?).

Mouse position is relative to the picture control origin.

Elements

Name Description
Mouse Position The vertical and horizontal coordinates that define the position of the mouse in the picture control.
  • X—The X coordinate of the mouse in the picture control.
  • Y—The Y coordinate of the mouse in the picture control.
Mouse Modifiers Cluster of Booleans that indicate whether various actions occur while the mouse is in the picture control.
  • Button Down—Indicates whether the user clicks the left mouse button while the mouse is in the picture control.
  • Shift Mod—Indicates whether the user presses the <Shift> key while the mouse is in the picture control.
  • Menu Mod—Indicates whether the user presses the platform-independent menu key while the mouse is in the picture control. (Windows) The menu key is the <Ctrl> key. (Mac OS) The menu key is the <Command> key.
  • Option Mod—(Windows) Indicates whether the user presses the <Ctrl> key while the mouse is in the picture control. (Mac OS) Indicates whether the user presses the <Option> key while the mouse is in the picture control.

Examples

Remarks

The following table lists the characteristics of this property.

Available in Run-Time Engine and Real-Time Operating SystemYes (Read Only)
PermissionsRead Only
Settable when the VI is runningNo
Loads the front panel into memoryNo
Need to authenticate before useNo
Loads the block diagram into memoryNo
Remote access disallowedNo
Must wait until user interface is idleNo
Available with control VIsNo
Available with global VIsNo
Available with strict type definitionsNo
Available with polymorphic VIsNo

Examples

Refer to the following VIs for examples of using the Mouse property:

  • Mouse Control Demo VI: labview\examples\picture\demos.llb

     Open example  Browse related examples

  • Pen Attributes And Image subsetting VI: labview\examples\picture\pictctl.llb

     Open example  Browse related examples