VisualTreeHelper.HitTest Method (Visual, Point)

Returns the top-most Visual object of a hit test by specifying a Point.

Namespace: System.Windows.Media
Assembly: PresentationCore (in presentationcore.dll)

public static HitTestResult HitTest (
	Visual reference,
	Point point
)
public static HitTestResult HitTest (
	Visual reference, 
	Point point
)
public static function HitTest (
	reference : Visual, 
	point : Point
) : HitTestResult
You cannot use methods in XAML.

Parameters

reference

The Visual to hit test.

point

The point value to hit test against.

Return Value

The hit test result of the Visual returned as a HitTestResult type.

The VisualHit property of the return value represents the Visual object that was hit.

NoteNote:

It is possible for a hit test that starts in a 2D visual tree to return RayHitTestResult, which is a 3D hit test result object. Hit testing that starts in a 2D visual tree seamlessly extends into any defined 3D visual tree.

The following example shows how to use the HitTest method to hit test the objects within a Canvas.

// Respond to the left mouse button down event by initiating the hit test.
public void OnMouseLeftButtonDown(object sender, MouseButtonEventArgs e)
{
    // Retrieve the coordinate of the mouse position.
    Point pt = e.GetPosition((UIElement)sender);

    // Perform the hit test against a given portion of the visual object tree.
    HitTestResult result = VisualTreeHelper.HitTest(myCanvas, pt);

    if (result != null)
    {
        // Perform action on hit visual object.
    }
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

ADD
Show: