InkPicture.HitTestSelection Method

Article
10/19/2012

Returns a value that indicates which part of a selection, if any, was hit during a hit test.

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

Syntax

'Declaration
Public Function HitTestSelection ( _
    X As Integer, _
    Y As Integer _
) As SelectionHitResult
'Usage
Dim instance As InkPicture 
Dim X As Integer 
Dim Y As Integer 
Dim returnValue As SelectionHitResult 

returnValue = instance.HitTestSelection(X, _
    Y)

public SelectionHitResult HitTestSelection(
    int X,
    int Y
)

public:
SelectionHitResult HitTestSelection(
    int X, 
    int Y
)

public function HitTestSelection(
    X : int, 
    Y : int
) : SelectionHitResult

Parameters

X
Type: System.Int32

The x-position, in pixels, of the hit test.

Y
Type: System.Int32

The y-position, in pixels, of the hit test.

Return Value

Type: Microsoft.Ink.SelectionHitResult
A member of the SelectionHitResult enumeration, which specifies which part of a selection, if any, was hit during a hit test.

Remarks

This method is only useful if the InkPicture.EditingMode property is set to Select.

Examples

In this example, when the MouseDown event fires, a check is made to see if EditingMode is set to Select. If so, the HitTestSelection method is called to determine which part of the selection (if any) has been hit. If the hit occurs on any of the four main compass directions, as specified by the SelectionHitResult enumeration, the stroke objects that are selected are changed to a different color.

Private Sub mInkPicture_MouseDown(ByVal sender As Object, ByVal e As MouseEventArgs)

    If InkOverlayEditingMode.Select = mInkPicture.EditingMode Then 
        Select Case mInkObject.HitTestSelection(e.X, e.Y)
            Case SelectionHitResult.North
                ChangeSelectionColor(Color.Green)
            Case SelectionHitResult.East
                ChangeSelectionColor(Color.Red)
            Case SelectionHitResult.South
                ChangeSelectionColor(Color.Purple)
            Case SelectionHitResult.West
                ChangeSelectionColor(Color.Blue)
        End Select 
    End If 
End Sub

private void mInkPicture_MouseDown(object sender, MouseEventArgs e)
{
    if (InkOverlayEditingMode.Select == mInkPicture.EditingMode)
    {
        switch (mInkObject.HitTestSelection(e.X, e.Y))
        {
            case SelectionHitResult.North:
                ChangeSelectionColor(Color.Green);
                break;
            case SelectionHitResult.East:
                ChangeSelectionColor(Color.Red);
                break;
            case SelectionHitResult.South:
                ChangeSelectionColor(Color.Purple);
                break;
            case SelectionHitResult.West:
                ChangeSelectionColor(Color.Blue);
                break;
        }
    }
}

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