Geometry.StrokeContains Method (Pen, Point, Double, ToleranceType)

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)

'Declaration
Public Function StrokeContains ( _
	pen As Pen, _
	hitPoint As Point, _
	tolerance As Double, _
	type As ToleranceType _
) As Boolean

Parameters

pen
Type: System.Windows.Media.Pen

An object that defines the stroke of a geometry.

hitPoint
Type: System.Windows.Point

The point to test for containment.

tolerance
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
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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft