InkCollector.MouseWheel Event

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

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

Syntax

'Declaration
Public Event MouseWheel As InkCollectorMouseWheelEventHandler
'Usage
Dim instance As InkCollector 
Dim handler As InkCollectorMouseWheelEventHandler 

AddHandler instance.MouseWheel, handler
public event InkCollectorMouseWheelEventHandler MouseWheel
public:
 event InkCollectorMouseWheelEventHandler^ MouseWheel {
    void add (InkCollectorMouseWheelEventHandler^ value);
    void remove (InkCollectorMouseWheelEventHandler^ value);
}
JScript does not support events.

Remarks

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

When you create an 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.

Note

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.

Examples

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

Private Sub mInkObject_MouseWheel(ByVal sender As Object, ByVal e As CancelMouseEventArgs)
    Using S As Strokes = mInkObject.Ink.Strokes
        If (S.Count > 0) Then
            S.Move(0, e.Delta)
            panelInkCanvas.Invalidate()
        End If 
    End Using 
End Sub
private void mInkObject_MouseWheel(object sender, CancelMouseEventArgs e)
{
    using (Strokes S = mInkObject.Ink.Strokes)
    {
        if (S.Count > 0)
        {
            S.Move(0, e.Delta);
            panelInkCanvas.Invalidate();
        }
    }
}

Platforms

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.

Version Information

.NET Framework

Supported in: 3.0

See Also

Reference

InkCollector Class

InkCollector Members

Microsoft.Ink Namespace

CancelMouseEventArgs

InkCollector.MouseMove