This documentation is archived and is not being maintained.

InkOverlay.CursorInRange Event

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

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

public event InkCollectorCursorInRangeEventHandler CursorInRange

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

When you create an InkCollectorCursorInRangeEventHandler 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 CursorInRange 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 CursorInRange event fires, a check is made to see if this is the first time that the InkOverlay object has come in contact with this particular Cursor object. If so, the DrawingAttributes property is assigned with a clone of the DefaultDrawingAttributes property. This ensures that subsequent access to the DrawingAttributes property does not throw a null reference exception.

private void mInkObject_CursorInRange(object sender, InkCollectorCursorInRangeEventArgs e)
    const int MOUSE_CURSOR_ID = 1;

    if (e.NewCursor)
        // mInkObject can be InkCollector, InkOverlay, or InkPicture
        e.Cursor.DrawingAttributes = mInkObject.DefaultDrawingAttributes.Clone();
        // if this cursor is the mouse, we'll set color to red 
        if (MOUSE_CURSOR_ID == e.Cursor.Id)
            e.Cursor.DrawingAttributes.Color = Color.Red;

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