Geometry.StrokeContains Method (Pen, Point)

 

Determines whether the specified Point is contained in the stroke produced by applying the specified Pen to the geometry.

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

member StrokeContains : 
        pen:Pen *
        hitPoint:Point -> bool

Parameters

pen
Type: System.Windows.Media.Pen

An object that determines the area of the geometry's stroke.

hitPoint
Type: System.Windows.Point

The point to test for containment.

Return Value

Type: System.Boolean

true if hitPoint is contained in the stroke produced by applying the specified Pen to the geometry; otherwise, false.

The default tolerance factor (specified by the StandardFlatteningTolerance property) is used when determining whether the specified point is located in the geometry's stroke. To specify your own tolerance factor, use the StrokeContains overload.

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
Show: