InkCollectorCursorOutOfRangeEventHandler Delegate

Article
10/19/2012

Represents the method that handles the CursorOutOfRange event of an InkCollector object.

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

Syntax

'Declaration
Public Delegate Sub InkCollectorCursorOutOfRangeEventHandler ( _
    sender As Object, _
    e As InkCollectorCursorOutOfRangeEventArgs _
)
'Usage
Dim instance As New InkCollectorCursorOutOfRangeEventHandler(AddressOf HandlerMethod)

public delegate void InkCollectorCursorOutOfRangeEventHandler(
    Object sender,
    InkCollectorCursorOutOfRangeEventArgs e
)

public delegate void InkCollectorCursorOutOfRangeEventHandler(
    Object^ sender, 
    InkCollectorCursorOutOfRangeEventArgs^ e
)

JScript does not support delegates.

Parameters

sender
Type: System.Object

The source InkCollector object of this event.

e
Type: Microsoft.Ink.InkCollectorCursorOutOfRangeEventArgs

The InkCollectorCursorOutOfRangeEventArgs object that contains the event data.

Remarks

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.

Examples

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
            panelInkCanvas.Invalidate()
        End If 
    End Using 
End Sub

private void mInkObject_CursorOutOfRange(object sender, InkCollectorCursorOutOfRangeEventArgs e)
{
    using (Strokes S = mInkObject.Ink.Strokes)
    {
        if (S.Count > 0)
        {
            S[S.Count - 1].DrawingAttributes.Color = Color.Tomato;
            // redraw the ink canvas
            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

Share via