SftOptions.MouseDown Event
A mouse button is pressed.
Syntax
| VB.NET | Private Sub object_MouseDownEvent(ByVal sender As Object, ByVal e As EventArgumentType) Handles object.MouseDownEvent |
| VB | Private Sub object_MouseDown(ByVal Button As Integer, ByVal Shift As Integer, ByVal xPos As OLE_XPOS_PIXELS, ByVal yPos As OLE_YPOS_PIXELS) |
| C#.NET | void object_MouseDownEvent(object sender, EventArgumentType e); |
| VC++ | void OnMouseDownobject(short Button, short Shift, OLE_XPOS_PIXELS xPos, OLE_YPOS_PIXELS yPos); |
| C | HRESULT OnMouseDownobject(short Button, short Shift, OLE_XPOS_PIXELS xPos, OLE_YPOS_PIXELS yPos); |
object
A SftOptions object.
Button
Describes the button(s) that are pressed. The Button argument is a bit field with bits corresponding to the left button, right button and middle button. These bits correspond to the values shown below. The bits set indicate the button that caused the event.
| Button | Value | Description |
|---|
| constSftOptionsLeftButton | 1 | The left mouse button was pressed. |
| constSftOptionsRightButton | 2 | The middle mouse button was pressed. |
| constSftOptionsMiddleButton | 4 | The right mouse button was pressed. |
Shift
Describes the state of the SHIFT, CONTROL and ALT keys. A bit is set if the key is down. The Shift argument is a bit field with bits corresponding to the SHIFT, CONTROL and ALT keys. It indicates the state of these keys. Some, all, or none of the bits can be set, indicating which of the keys are pressed.
| Shift | Value | Description |
|---|
| constSftOptionsShiftMask | 1 | The SHIFT key is down. |
| constSftOptionsCtrlMask | 2 | The CONTROL key is down. |
| constSftOptionsAltMask | 4 | The ALT key is down. |
xPos
The x coordinate of the mouse cursor. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
yPos
The y coordinate of the mouse cursor. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.
Comments
The MouseDown event occurs when a mouse button is pressed.
The MouseDown event can be used by an application to handle mouse button clicks in combination with keyboard modifiers such as the SHIFT, CONTROL and ALT keys.
The HitTest method can be used if specific information about the logical position of the mouse cursor is needed.
This event should not be used to determine selection changes. The SelectionChange event should be used instead.
The ContextMenu event can be used to respond to right mouse button clicks.
See Also SftOptions Object | Object Hierarchy
On
Off