MouseDown Event

Description

This event occurs when the user presses a mouse button in a window belonging to the application.

Syntax

Visual Basic
Public Event MouseDown( _ ByVal sButton As Integer, _ ByVal sShift As Integer, _ ByVal dX As Double, _ ByVal dY As Double, _ ByVal dZ As Double, _ ByVal pWindowDispatch As Object, _ ByVal lKeyPointType As Long, _ ByVal pGraphicDispatch As Object _ )

Visual Basic

Public Event MouseDown( _
   ByVal sButton As Integer, _
   ByVal sShift As Integer, _
   ByVal dX As Double, _
   ByVal dY As Double, _
   ByVal dZ As Double, _
   ByVal pWindowDispatch As Object, _
   ByVal lKeyPointType As Long, _
   ByVal pGraphicDispatch As Object _
)

Parameters

sButton: Specifies on which button the click occurred. Valid values are vbLeftButton, vbRightButton, or vbMiddleButton.
sShift: Bitmask that determines the states of the Ctrl, Shift, and Alt keys when the mouse was clicked. For example, if both the Ctrl and Shift keys are pressed, the value is 6.
dX: Returns the x coordinate of the mouse in either the window or model coordinate system, depending on the value of the ScaleMode property.
dY: Returns the y coordinate of the mouse in either the window or model coordinate system, depending on the value of the ScaleMode property.
dZ: Returns the z coordinate of the mouse in the model coordinate system if the scale mode property is set to igMouseModel and the mouse event occurred in a graphic view; otherwise 0.
pWindowDispatch: Returns the window object in which the event occurred.
lKeyPointType: If the mouse is over a graphic object when the mouse event occurs and the underlying application supports automatic key-point snapping, then this argument contains the index of the key point. Key points are significant points such as the center of a circle, end point of a line, and so on. The value of this index depends on the specific type of graphic object; a value of -1 is considered to be an invalid key point.
pGraphicDispatch: If the mouse is over a graphic object when the mouse event occurs and the underlying application supports automatic key-point snapping, then this will contain the graphic.

Remarks

The values of the constants are defined in the Visual Basic object library in the object browser. Effort is made to ensure that the mouse events are fired in sequence. To do this when a mouse down event occurs, the mouse input is locked to the window in which the down event occurred. When the corresponding mouse up event occurs, the lock is removed. This sequence ensures that the command will always receive a mouse up event after receiving a mouse down event. Because the mouse up event will occur in the same window as the down event this implies that it is not possible to drag across windows.