MouseDrag Method

Description

This event occurs when the user moves a mouse in a window that belongs to the application with a mouse button pressed.

Syntax

Visual Basic
Public Sub MouseDrag( _ 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 DragState As Integer, _ ByVal lKeyPointType As Long, _ ByVal pGraphicDispatch As Object _ )

Visual Basic

Public Sub MouseDrag( _
   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 DragState As Integer, _
   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.
DragState: A constant value that specifies the drag state of the mouse: seMouseEnterDrag (0), seMouseDrag(1), or seMouseExitDrag(2).
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 argument will contain the graphic.

Remarks

The values of the constants are defined in the Visual Basic object libraries in the object browser. MouseDrag events are only fired if the EnableMouseDrag property is True.