MouseWheel Event

InkOverlay.MouseWheel Event

Occurs when a user moves the mouse wheel while the InkOverlay object has focus.

Namespace:  Microsoft.Ink
Assembly:  Microsoft.Ink (in Microsoft.Ink.dll)

public event InkCollectorMouseWheelEventHandler MouseWheel

The event handler receives an argument of type CancelMouseEventArgs containing data about this event.

When you create a InkCollectorMouseDownEventHandler delegate, you identify the method that handles the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For performance reasons, the default event interest is off but is turned on automatically if you add an event handler.

To improve real-time ink performance, hide the mouse cursor while inking. To do so, hide the mouse cursor in the MouseDown event handler, and show the mouse cursor in the MouseUp event handler.


The CancelMouseEventArgs object's X and Y properties 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 an application that is not pen-aware, and that type of application is depicted in pixels.

In this example, when the MouseWheel event fires, all strokes are scrolled according to the mouse wheel rotation amount and direction.

private void mInkObject_MouseWheel(object sender, CancelMouseEventArgs e)
    using (Strokes S = mInkObject.Ink.Strokes)
        if (S.Count > 0)
            S.Move(0, e.Delta);

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.0

Community Additions

© 2016 Microsoft