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

public:
virtual bool DoHitTest(
	DiagramClientView^ view,
	PointD point,
	List<ShapeElement^>^ shapesHit,
	bool includeTolerance
)

Parameters

view
Type: Microsoft.VisualStudio.Modeling.Diagrams::DiagramClientView^

The client view for the diagram. If the diagram does not have a client view, null.

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

The top-left point in the diagram.

shapesHit
Type: System.Collections.Generic::List<ShapeElement^>^

The object to receive the list of hit shapes.

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.

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

Return to top
Show: