Diagram.DoHitTest Method (PointD, DiagramHitTestInfo, 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 Overrides Function DoHitTest ( _
    point As PointD, _
    hitTestInfo As DiagramHitTestInfo, _
    includeTolerance As Boolean _
) As Boolean

public override bool DoHitTest(
    PointD point,
    DiagramHitTestInfo hitTestInfo,
    bool includeTolerance
)

public:
virtual bool DoHitTest(
    PointD point, 
    DiagramHitTestInfo^ hitTestInfo, 
    bool includeTolerance
) override

abstract DoHitTest : 
        point:PointD * 
        hitTestInfo:DiagramHitTestInfo * 
        includeTolerance:bool -> bool  
override DoHitTest : 
        point:PointD * 
        hitTestInfo:DiagramHitTestInfo * 
        includeTolerance:bool -> bool

public override function DoHitTest(
    point : PointD, 
    hitTestInfo : DiagramHitTestInfo, 
    includeTolerance : boolean
) : boolean

Parameters

• point
  Type: Microsoft.VisualStudio.Modeling.Diagrams.PointD

  The top-left point in the diagram.

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

  The object that receives the results of the hit test.

• 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

• 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.

See Also

Reference

Diagram Class

DoHitTest Overload

Microsoft.VisualStudio.Modeling.Diagrams Namespace