Geometry::StrokeContains Method (Pen^, Point, Double, ToleranceType)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Determines whether the specified Point is contained in the stroke produced by applying the specified Pen to the geometry, given the specified margin of error.

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

bool StrokeContains(
	Pen^ pen,
	Point hitPoint,
	double tolerance,
	ToleranceType type


Type: System.Windows.Media::Pen^

An object that defines the stroke of a geometry.

Type: System.Windows::Point

The point to test for containment.

Type: System::Double

The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution. If tolerance is less than .000001, .000001 is used instead.

Type: System.Windows.Media::ToleranceType

One of the ToleranceType values that specifies whether the tolerance factor is an absolute value or relative to the area of the geometry.

Return Value

Type: System::Boolean

true if the stroke created by applying the specified Pen to the geometry contains the specified point, given the specified tolerance factor; otherwise, false.

Some Geometry methods (such as StrokeContains) produce or use a polygonal approximation of the geometry. The tolerance factor specifies the maximum distance between points in this polygonal approximation. Smaller tolerance values produce better approximations, but require more processing than an approximation with a large tolerance factor.

.NET Framework
Available since 3.0
Return to top