Mouse Property

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Short Name: Mouse

Requires: Base Development System

Class: Picture Properties

To Use: Create a property.

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 X) 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 X) Indicates whether the user presses the <Option> key while the mouse is in the picture control.

Example

Remarks

The following table lists the characteristics of this property.

Data type
PermissionsRead Only
Available in Run-Time EngineYes (Read Only)
Available in Real-Time Operating SystemYes
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 allowedYes

Example

Refer to the Pen Attributes And Image subsetting VI in the labview\examples\Graphics and Sound\2D Picture Control directory for an example of using the Mouse property.

WAS THIS ARTICLE HELPFUL?

Not Helpful