InkOverlay.MouseUp event

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


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


Button [in]

The mouse button that was released.

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.

Return value

This event does not return a value.


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.
Note  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_IPEMouseUp.


Minimum supported client

Windows XP Tablet PC Edition [desktop apps only]

Minimum supported server

None supported


Msinkaut.h (also requires Msinkaut_i.c)



See also

InkOverlay Class
InkMouseButton Enumeration
InkShiftKeyModifierFlags Enumeration