ShapeGeometry.DoHitTest Method (IGeometryHost, PointD, DiagramHitTestInfo, Boolean)

Determines whether a point is inside a shape.

Namespace: Microsoft.VisualStudio.Modeling.Diagrams
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Diagrams (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.dll)

Syntax

'Declaration
Public MustOverride Function DoHitTest ( _
    geometryHost As IGeometryHost, _
    hitPoint As PointD, _
    hitTestInfo As DiagramHitTestInfo, _
    includeTolerance As Boolean _
) As Boolean

'Usage
Dim instance As ShapeGeometry 
Dim geometryHost As IGeometryHost 
Dim hitPoint As PointD 
Dim hitTestInfo As DiagramHitTestInfo 
Dim includeTolerance As Boolean 
Dim returnValue As Boolean 

returnValue = instance.DoHitTest(geometryHost, _
    hitPoint, hitTestInfo, includeTolerance)

public abstract bool DoHitTest(
    IGeometryHost geometryHost,
    PointD hitPoint,
    DiagramHitTestInfo hitTestInfo,
    bool includeTolerance
)

public:
virtual bool DoHitTest(
    IGeometryHost^ geometryHost, 
    PointD hitPoint, 
    DiagramHitTestInfo^ hitTestInfo, 
    bool includeTolerance
) abstract

public abstract function DoHitTest(
    geometryHost : IGeometryHost, 
    hitPoint : PointD, 
    hitTestInfo : DiagramHitTestInfo, 
    includeTolerance : boolean
) : boolean

Parameters

geometryHost
Type: Microsoft.VisualStudio.Modeling.Diagrams.IGeometryHost

The shape or link.

hitPoint
Type: Microsoft.VisualStudio.Modeling.Diagrams.PointD

The point to test, relative to the bounds of the shape.

hitTestInfo
Type: Microsoft.VisualStudio.Modeling.Diagrams.DiagramHitTestInfo

The object that will receive the results of the hit test.

includeTolerance
Type: System.Boolean

true to include additional tolerance around the shape geometry when the hit test is performed; otherwise, false. If true, the test will result true even if the point is slightly outside the shape, unless there is a sibling shape directly underneath.

Return Value

Type: System.Boolean
true if the shape geometry was hit; otherwise, false.

Remarks

The geometry boundary includes the thickness of the outline pen that lies outside of the graphics path used to draw the geometry.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.