MouseDown Event, SftTree Object
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 x As OLE_XPOS_PIXELS, ByVal y As OLE_YPOS_PIXELS) |
| C#.NET | void object_MouseDownEvent(object sender, EventArgumentType e); |
| VC++ | void OnMouseDownobject(short Button, short Shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y); |
| C | HRESULT OnMouseDownobject(short Button, short Shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y); |
object
A SftTree object.
Button
The button that is pressed during the event (see SftTreeButtonConstants). 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. Only one of the bits is set, indicating the button that caused the event.
| Button | Value | Description |
|---|
| constSftTreeLeftButton | 1 | The left mouse button was pressed. |
| constSftTreeRightButton 1) | 2 | The right mouse button was pressed. |
| constSftTreeMiddleButton 1) | 4 | The middle mouse button was pressed. |
Shift
The state of the SHIFT, CONTROL and ALT keys during the event (see SftTreeKeyConstants). 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. The Shift variable 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 |
|---|
| constSftTreeShiftMask | 1 | The SHIFT key was pressed. |
| constSftTreeCtrlMask | 2 | The CONTROL key was pressed. |
| constSftTreeAltMask | 4 | The ALT key was pressed. |
x
The x coordinate of the mouse cursor when the button was pressed.
y
The y coordinate of the mouse cursor when the button was pressed.
Comments
The MouseDown event occurs when a mouse button is pressed.
1) Depending on the settings of the LeftButtonOnly or LeftItemClickOnly properties, this event may not be generated for the middle and right mouse buttons.
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 ItemClick event should be used if specific information about the logical position of the mouse cursor is needed.
If the MouseDown event is used to display a context sensitive menu (popup menu), the CancelMode method must be used before displaying the context menu.
See Also SftTree Object | Object Hierarchy
On
Off