InkCanvas.HitTestSelection Method (Point)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Returns a value that indicates which part of the selection adorner intersects or surrounds the specified point.

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)

Public Function HitTestSelection (
	point As Point
) As InkCanvasSelectionHitResult


Type: System.Windows.Point

The point to hit test.

Return Value

Type: System.Windows.Controls.InkCanvasSelectionHitResult

A value that indicates which part of the selection adorner intersects or surrounds a specified point.

Use the HitTestSelection method to determine whether the point is within a stroke selection's bounds or on one of the eight handles. This is useful when performing drag and drop operations.

The following example demonstrates how use HitTestSelection to determine whether to create a DataObject to initiate drag and drop. To implement drag and drop between two InkCanvas objects, see How to: Drag and Drop Ink.

Private Sub InkCanvas_PreviewMouseDown(ByVal sender As Object, _
                               ByVal e As MouseButtonEventArgs)

    Dim ic As InkCanvas = CType(sender, InkCanvas)

    Dim pt As Point = e.GetPosition(ic)

    ' If the user is moving selected strokes, prepare the strokes to be
    ' moved to another InkCanvas.
    If ic.HitTestSelection(pt) = InkCanvasSelectionHitResult.Selection Then

        Dim selectedStrokes As StrokeCollection = _

        Dim strokesToMove As StrokeCollection = _

        ' Remove the offset of the selected strokes so they
        ' are positioned when the strokes are dropped.
        Dim inkBounds As Rect = strokesToMove.GetBounds()
        TranslateStrokes(strokesToMove, -inkBounds.X, -inkBounds.Y)

        ' Perform drag and drop.
        Dim ms As New MemoryStream()

        Dim dataObject As New DataObject _
            (StrokeCollection.InkSerializedFormat, ms)

        Dim effects As DragDropEffects = _
            DragDrop.DoDragDrop(ic, dataObject, DragDropEffects.Move)

        If (effects And DragDropEffects.Move) = DragDropEffects.Move Then

            ' Remove the selected strokes from the current InkCanvas.
        End If
    End If

End Sub 'OnMouseDown

.NET Framework
Available since 3.0
Return to top