Diagram.DoHitTest Method (DiagramClientView, PointD, List<ShapeElement>, Boolean)

Performs a hit test on the diagram.

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

Syntax

'Declaration
Public Overridable Function DoHitTest ( _
    view As DiagramClientView, _
    point As PointD, _
    shapesHit As List(Of ShapeElement), _
    includeTolerance As Boolean _
) As Boolean
'Usage
Dim instance As Diagram 
Dim view As DiagramClientView 
Dim point As PointD 
Dim shapesHit As List(Of ShapeElement)
Dim includeTolerance As Boolean 
Dim returnValue As Boolean 

returnValue = instance.DoHitTest(view, _
    point, shapesHit, includeTolerance)
public virtual bool DoHitTest(
    DiagramClientView view,
    PointD point,
    List<ShapeElement> shapesHit,
    bool includeTolerance
)
public:
virtual bool DoHitTest(
    DiagramClientView^ view, 
    PointD point, 
    List<ShapeElement^>^ shapesHit, 
    bool includeTolerance
)
public function DoHitTest(
    view : DiagramClientView, 
    point : PointD, 
    shapesHit : List<ShapeElement>, 
    includeTolerance : boolean
) : boolean

Parameters

  • includeTolerance
    Type: System.Boolean

    true to include tolerance around the shape when the hit test determines whether the shape has been hit; otherwise, false. Tolerance increases the hit diameter around the shape.

Return Value

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

Remarks

A hit test verifies whether a point is over a shape on the diagram.

.NET Framework Security

See Also

Reference

Diagram Class

Diagram Members

DoHitTest Overload

Microsoft.VisualStudio.Modeling.Diagrams Namespace