InkOverlaySelectionChangingEventHandler Delegate

Article
10/19/2012

Represents the method that handles the SelectionChanging event of an InkOverlay object.

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

Syntax

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

public delegate void InkOverlaySelectionChangingEventHandler(
    Object sender,
    InkOverlaySelectionChangingEventArgs e
)

public delegate void InkOverlaySelectionChangingEventHandler(
    Object^ sender, 
    InkOverlaySelectionChangingEventArgs^ e
)

JScript does not support delegates.

Parameters

sender
Type: System.Object

The source InkOverlay object of this event.

e
Type: Microsoft.Ink.InkOverlaySelectionChangingEventArgs

The InkOverlaySelectionChangingEventArgs object that contains the event data.

Remarks

The SelectionChanging event occurs when the selection of ink within the control is about to change, such as through alterations to the user interface, cut-and-paste procedures, or the Selection property.

When you create an InkOverlaySelectionChangingEventHandler 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 in managed code but is turned on automatically if you add an event handler.

Examples

In this example, the SelectionChanging event handler prohibits the selection of multiple strokes by removing all but one Stroke object from the current selection.

Private Sub mInkObject_SelectionChanging(ByVal sender As Object, ByVal e As InkOverlaySelectionChangingEventArgs)
    While e.NewSelection.Count > 1
        e.NewSelection.RemoveAt(e.NewSelection.Count - 1)
    End While 
End Sub

private void mInkObject_SelectionChanging(object sender, InkOverlaySelectionChangingEventArgs e)
{
    while (e.NewSelection.Count > 1)
    {
        e.NewSelection.RemoveAt(e.NewSelection.Count - 1);
    }
}

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