Share via


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.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0.dll)

Syntax

'Declaration
Public Overridable Function DoHitTest ( _
    view As DiagramClientView, _
    point As PointD, _
    shapesHit As List(Of ShapeElement), _
    includeTolerance As Boolean _
) As Boolean
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
)
abstract DoHitTest : 
        view:DiagramClientView * 
        point:PointD * 
        shapesHit:List<ShapeElement> * 
        includeTolerance:bool -> bool  
override DoHitTest : 
        view:DiagramClientView * 
        point:PointD * 
        shapesHit:List<ShapeElement> * 
        includeTolerance:bool -> bool
public function DoHitTest(
    view : DiagramClientView, 
    point : PointD, 
    shapesHit : List<ShapeElement>, 
    includeTolerance : boolean
) : boolean

Parameters

  • shapesHit
    Type: List<ShapeElement>

    The object to receive the list of hit shapes.

  • includeTolerance
    Type: 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: 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

DoHitTest Overload

Microsoft.VisualStudio.Modeling.Diagrams Namespace