Stroke.HitTest Method

Article
10/19/2012

Returns a value that indicates whether a Stroke object is either completely inside or intersected by a given circle.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Function HitTest ( _
    pt As Point, _
    radius As Single _
) As Boolean
'Usage
Dim instance As Stroke 
Dim pt As Point 
Dim radius As Single 
Dim returnValue As Boolean 

returnValue = instance.HitTest(pt, radius)

public bool HitTest(
    Point pt,
    float radius
)

public:
bool HitTest(
    Point pt, 
    float radius
)

public function HitTest(
    pt : Point, 
    radius : float
) : boolean

Parameters

pt
Type: System.Drawing.Point

The center of the hit test circle, in ink space coordinates.

radius
Type: System.Single

The radius of the hit test circle.

Return Value

Type: System.Boolean
Whether a Stroke object is either completely inside or intersected by a given circle.

Value	Meaning
true	The Stroke object is either completely inside or intersected by the circle.
false	The Stroke object is completely outside the circle.

Examples

This C# example returns a value that indicates whether any part of the Stroke object, theStroke, is within the distance, theRadius, of a Point, thePoint, which is in ink space coordinates.

bool isAHit = theStroke.HitTest(thePt, theRadius);

This Microsoft Visual Basic .NET example returns a value that indicates whether any part of the Stroke object, theStroke, is within the distance, theRadius, of a Point, thePoint, which is in ink space coordinates.

Dim isAHit As Boolean = theStroke.HitTest(thePt, theRadius)

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

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

Version Information

.NET Framework

Supported in: 3.0

Share via