InkCollector.MouseWheel event

Article
04/27/2021

Occurs when the mouse wheel moves while the InkCollector or InkOverlay object has focus.

Syntax

void MouseWheel(
  [in]      InkMouseButton           Button,
  [in]      InkShiftKeyModifierFlags Shift,
  [in]      long                     Delta,
  [in]      long                     x,
  [in]      long                     y,
  [in, out] VARIANT_BOOL             *Cancel
);

Parameters

Button [in]: The mouse button that was pressed.
Shift [in]: The state of the SHIFT key.
Delta [in]: A signed count of the number of detents the mouse wheel has rotated. A detent is one notch of the mouse wheel.
x [in]: The x-coordinate, in pixels, of a mouse click.
y [in]: The y-coordinate, in pixels, of a mouse click.
Cancel [in, out]: VARIANT_TRUE to cancel the event for the parent control; otherwise, VARIANT_FALSE. The default value is VARIANT_FALSE.

Return value

This event does not return a value.

Remarks

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.

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

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Header	Msinkaut.h (also requires Msinkaut_i.c)
Library	InkObj.dll