InkEdit.MouseDown event

Occurs when the user presses a mouse button while the mouse is over the InkEdit control.

Syntax

HRESULT MouseDown(
   short Button,
   short ShiftKey,
   long  xMouse,
   long  yMouse
);

Parameters

Button

A member of the MouseButton enumeration that indicates which mouse buttons were pressed.

Value	Meaning
NO_BUTTON	Default. No mouse button was pressed.
LEFT_BUTTON	The left mouse button was pressed.
RIGHT_BUTTON	The right mouse button was pressed.
MIDDLE_BUTTON	The middle mouse button was pressed.

ShiftKey

A member of the InkShiftKeyModifierFlags enumeration that indicates which modifier keys are depressed at the time of the event.

Value	Meaning
IKM_Shift	Specifies that the SHIFT key was used as a modifier.
IKM_Control	Specifies that the CTRL key was used as a modifier.
IKM_Alt	Specifies that the ALT key was used as a modifier.

xMouse

The current x coordinate, in pixels, of the mouse pointer.

yMouse

The current y coordinate, in pixels, of the mouse pointer.

Return value

If this event succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If a mouse button is pressed while the pointer is over an InkEdit control, that control captures the mouse and receives all mouse events up to and including the last MouseUp event. This implies that the (x, y) mouse-pointer coordinates returned by a mouse event may not always be in the internal area of the object that receives them.

If mouse buttons are pressed in succession, the object that captures the mouse after the first press receives all mouse events until all buttons are released.

This event method is defined in the _IInkEditEvents interface. The _IInkEditEvents interface implements the IDispatch interface with an identifier of DISPID_IeeMouseDown.

Requirements

See also

InkEdit

InkMouseButton Enumeration

InkShiftKeyModifierFlags Enumeration

MouseMove Event [InkEdit Control]

MouseUp Event [InkEdit Control]