HitTestResult Class

Provides the base class for several derived classes that represents the return value from a hit test.

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

Public MustInherit Class HitTestResult

The HitTestResult type exposes the following members.

Public propertyVisualHitGets the visual object that was hit.

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The PointHitTestResult, GeometryHitTestResult, and RayHitTestResult classes derive from HitTestResult.

The following example shows how to retrieve the HitTestResult return value from the HitTest method.

		' Respond to the left mouse button down event by initiating the hit test.
		Private Overloads Sub OnMouseLeftButtonDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
			' Retrieve the coordinate of the mouse position.
			Dim pt As Point = e.GetPosition(CType(sender, UIElement))

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

			If result IsNot Nothing Then
				' Perform action on hit visual object.
			End If
		End Sub

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft