InkCanvasSelectionHitResult Enum

Definition

Identifies the various parts of a selection adorner on an InkCanvas.

C#
public enum InkCanvasSelectionHitResult
Inheritance
InkCanvasSelectionHitResult

Fields

Name Value Description
None 0

No part of the selection adorner.

TopLeft 1

The upper left handle of the selection adorner.

Top 2

The upper middle handle of the selection adorner.

TopRight 3

The upper right handle of the selection adorner.

Right 4

The middle handle on the right edge of the selection adorner.

BottomRight 5

The lower right handle of the selection adorner.

Bottom 6

The lower middle handle of the selection adorner.

BottomLeft 7

The lower left handle of the selection adorner.

Left 8

The middle handle on the left edge of the selection adorner.

Selection 9

The area within the bounds of the selection adorner.

Examples

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.

C#
void InkCanvas_PreviewMouseDown(object sender, MouseEventArgs e)
{
    InkCanvas ic = (InkCanvas)sender;
    
    Point pt = 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)
    {
        StrokeCollection selectedStrokes = ic.GetSelectedStrokes();
        StrokeCollection strokesToMove = selectedStrokes.Clone();
    
        // Remove the offset of the selected strokes so they
        // are positioned when the strokes are dropped.
        Rect inkBounds = strokesToMove.GetBounds();
        TranslateStrokes(strokesToMove, -inkBounds.X, -inkBounds.Y);
        
        // Perform drag and drop.
        MemoryStream ms = new MemoryStream();
        strokesToMove.Save(ms);
        DataObject dataObject = new DataObject(
            StrokeCollection.InkSerializedFormat, ms);
        
        DragDropEffects effects = 
            DragDrop.DoDragDrop(ic, dataObject, 
                                DragDropEffects.Move);

        if ((effects & DragDropEffects.Move) == 
             DragDropEffects.Move)
        {
            // Remove the selected strokes 
            // from the current InkCanvas.
            ic.Strokes.Remove(selectedStrokes);
        }
    }
}

Remarks

The HitTestSelection method returns an InkCanvasSelectionHitResult to indicate which part of the selection adorner intersects or surrounds a Point. This is useful when performing drag-and-drop operations.

XAML Text Usage

This class is not typically used in XAML.

Applies to

Product Versions
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9