Diagram.HitTest Method

Gets the shapes to include in the hit test.

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

Syntax

'Declaration
Public Function HitTest ( _
    clipRectangle As RectangleD, _
    requireCompleteContainment As Boolean _
) As ICollection

'Usage
Dim instance As Diagram 
Dim clipRectangle As RectangleD 
Dim requireCompleteContainment As Boolean 
Dim returnValue As ICollection 

returnValue = instance.HitTest(clipRectangle, _
    requireCompleteContainment)

public ICollection HitTest(
    RectangleD clipRectangle,
    bool requireCompleteContainment
)

public:
ICollection^ HitTest(
    RectangleD clipRectangle, 
    bool requireCompleteContainment
)

public function HitTest(
    clipRectangle : RectangleD, 
    requireCompleteContainment : boolean
) : ICollection

Parameters

• clipRectangle
  Type: Microsoft.VisualStudio.Modeling.Diagrams.RectangleD

  The diameter of the selection rectangle.

• requireCompleteContainment
  Type: System.Boolean

  true to include a shape only if the whole shape is in the selection rectangle; false to include shapes that are partially in the selection rectangle.

Return Value

Type: System.Collections.ICollection
The shapes to include in the hit test.

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

Diagram Members

Microsoft.VisualStudio.Modeling.Diagrams Namespace