This documentation is archived and is not being maintained.

InkOverlay.CursorOutOfRange Event

Occurs when a cursor leaves the physical detection range (proximity) of the tablet context.

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

Public Event CursorOutOfRange As InkCollectorCursorOutOfRangeEventHandler
Dim instance As InkOverlay 
Dim handler As InkCollectorCursorOutOfRangeEventHandler 

AddHandler instance.CursorOutOfRange, handler

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

When you create an InkCollectorCursorOutOfRangeEventHandler 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. The default event interest is on.

The CursorOutOfRange event fires even when in select or erase mode, not only when in ink mode. This requires that you monitor the editing mode (which you are responsible for setting) and be aware of the mode before interpreting the event. The advantage of this requirement is greater freedom to innovate on the platform through greater awareness of platform events.

In this example, when the CursorOutOfRange event fires, the color of the last stroke to be created is changed to red.

Private Sub mInkObject_CursorOutOfRange(ByVal sender As Object, ByVal e As InkCollectorCursorOutOfRangeEventArgs)
    Using s As Strokes = mInkObject.Ink.Strokes
        If s.Count > 0 Then
            s(s.Count - 1).DrawingAttributes.Color = Color.Tomato
            ' redraw the ink canvas
        End If 
    End Using 
End Sub

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