Visual.HitTestCore Method

Definition

Namespace:

System.Windows.Media

Assembly:

PresentationCore.dll

Determines whether a point or geometry value is within the bounds of the visual object.

Overloads

HitTestCore(GeometryHitTestParameters)	Determines whether a geometry value is within the bounds of the visual object.
HitTestCore(PointHitTestParameters)	Determines whether a point coordinate value is within the bounds of the visual object.

HitTestCore(GeometryHitTestParameters)

Determines whether a geometry value is within the bounds of the visual object.

protected:
 virtual System::Windows::Media::GeometryHitTestResult ^ HitTestCore(System::Windows::Media::GeometryHitTestParameters ^ hitTestParameters);

protected virtual System.Windows.Media.GeometryHitTestResult HitTestCore (System.Windows.Media.GeometryHitTestParameters hitTestParameters);

abstract member HitTestCore : System.Windows.Media.GeometryHitTestParameters -> System.Windows.Media.GeometryHitTestResult
override this.HitTestCore : System.Windows.Media.GeometryHitTestParameters -> System.Windows.Media.GeometryHitTestResult

Protected Overridable Function HitTestCore (hitTestParameters As GeometryHitTestParameters) As GeometryHitTestResult

Parameters

hitTestParameters

GeometryHitTestParameters

A GeometryHitTestParameters object that specifies the Geometry to hit test against.

Returns

GeometryHitTestResult

A GeometryHitTestResult that represents the result of the hit test.

Examples

The following example shows how to override the HitTestCore(GeometryHitTestParameters) method. One reason you might want to override this method is to provide additional functionality during the hit testing process.

// Override default hit test support in visual object.
protected override GeometryHitTestResult HitTestCore(GeometryHitTestParameters hitTestParameters)
{
    IntersectionDetail intersectionDetail = IntersectionDetail.NotCalculated;

    // Perform custom actions during the hit test processing.

    return new GeometryHitTestResult(this, intersectionDetail);
}

' Override default hit test support in visual object.
Protected Overrides Overloads Function HitTestCore(ByVal hitTestParameters As GeometryHitTestParameters) As GeometryHitTestResult
    Dim intersectionDetail As IntersectionDetail = IntersectionDetail.NotCalculated

    ' Perform custom actions during the hit test processing.

    Return New GeometryHitTestResult(Me, intersectionDetail)
End Function

Remarks

You can override default hit testing support for a visual object by overriding the HitTestCore method. This means that when you invoke the HitTest method, your overridden implementation of HitTestCore is called. Your overridden method is called when a hit test falls within the bounding rectangle of the visual object, even if the coordinate falls outside the geometry of the visual object.

HitTestCore(PointHitTestParameters)

Determines whether a point coordinate value is within the bounds of the visual object.

protected:
 virtual System::Windows::Media::HitTestResult ^ HitTestCore(System::Windows::Media::PointHitTestParameters ^ hitTestParameters);

protected virtual System.Windows.Media.HitTestResult HitTestCore (System.Windows.Media.PointHitTestParameters hitTestParameters);

abstract member HitTestCore : System.Windows.Media.PointHitTestParameters -> System.Windows.Media.HitTestResult
override this.HitTestCore : System.Windows.Media.PointHitTestParameters -> System.Windows.Media.HitTestResult

Protected Overridable Function HitTestCore (hitTestParameters As PointHitTestParameters) As HitTestResult

Parameters

hitTestParameters

PointHitTestParameters

A PointHitTestParameters object that specifies the Point to hit test against.

Returns

HitTestResult

A HitTestResult that represents the Visual that is returned from a hit test.

Examples

The following example shows how to override the HitTestCore(PointHitTestParameters) method. One reason you might want to override this method is to provide additional functionality during the hit testing process.

// Override default hit test support in visual object.
protected override HitTestResult HitTestCore(PointHitTestParameters hitTestParameters)
{
    Point pt = hitTestParameters.HitPoint;

    // Perform custom actions during the hit test processing,
    // which may include verifying that the point actually
    // falls within the rendered content of the visual.

    // Return hit on bounding rectangle of visual object.
    return new PointHitTestResult(this, pt);
}

' Override default hit test support in visual object.
Protected Overrides Overloads Function HitTestCore(ByVal hitTestParameters As PointHitTestParameters) As HitTestResult
    Dim pt As Point = hitTestParameters.HitPoint

    ' Perform custom actions during the hit test processing,
    ' which may include verifying that the point actually
    ' falls within the rendered content of the visual.

    ' Return hit on bounding rectangle of visual object.
    Return New PointHitTestResult(Me, pt)
End Function

Remarks

You can override the default hit testing support on visual objects by overriding the HitTestCore method. This means that when you invoke the HitTest method, your overridden implementation of HitTestCore is called. Your overridden method is called when a hit test falls within the bounding rectangle of the visual object, even if the coordinate falls outside the geometry of the visual object.