Share via

MouseDown Event

  • Article

MouseDown Event

Occurs when the mouse pointer is over the InkCollector or InkOverlay object and a mouse button is pressed.

Declaration

[C++]

void MouseDown(
    [in] InkMouseButton Button,
    [in] InkShiftKeyModifierFlags Shift,
    [in] long pX,
    [in] long pY,
    [in, out] VARIANT_BOOL* Cancel
);

[Microsoft® Visual Basic® 6.0]

Public Event MouseDown( _
    Button As InkMouseButton, _
    Shift As InkShiftKeyModifierFlags, _
    pX As Long, _
    pY As Long, _
    Cancel As Boolean _
)

Parameters

Button

[in] The mouse button that was pressed.

Shift

[in] The state of the SHIFT key.

pX

[in] The x-coordinate, in pixels, of a mouse click.

pY

[in] The y-coordinate, in pixels, of a mouse click.

Cancel

[in, out] Whether the event should be canceled for the parent control. The default value is FALSE, which specifies that the event should not be canceled.

Remarks

To improve real-time ink performance, hide or show the mouse cursor in the MouseDown and MouseUp event handlers.

Note: The properties pX and pY are in pixels, and not the HIMETRIC units that are associated with the ink space. This is because this event replaces the related mouse event of a pen-unaware application and this type of application understands only pixels.

Warning: Some controls rely on a specific relationship between MouseDown, MouseMove, and MouseUp events. Canceling some of these events may have unanticipated results.

This event method is defined in the _IInkCollectorEvents, _IInkOverlayEvents, and _IInkPictureEvents dispatch-only interfaces (dispinterfaces) with an ID of DISPID_IPEMouseDown.

Applies To