Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

VisualTreeHelper.HitTest Method (Visual, Point)

 

Returns the topmost 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
)

Parameters

reference
Type: System.Windows.Media.Visual

The Visual to hit test.

point
Type: System.Windows.Point

The point value to hit test against.

Return Value

Type: System.Windows.Media.HitTestResult

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.

System_CAPS_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.
private 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.
    }
}

.NET Framework
Available since 3.0
Return to top
Show:
© 2017 Microsoft