Picture class/Mouse property

From LabVIEW Wiki
Jump to: navigation, search
VI Server Property Information
Property ID 6339803
Scope Basic Development Environment
Data Name Mouse
Short Name* Mouse
Long Name* Mouse
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 15
Owning Class Name Picture Class
Data Type Common Cluster TypeDef data type

Common Cluster TypeDef

Property Node Mouse
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes (Read Only)
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Need to authenticate before useNo
PermissionsRead Only
Remote access allowedYes
Settable when the VI is runningNo

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.


Uses

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links