Diagram.HitTest Method

Gets the shapes to include in the hit test.

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

Syntax

'Declaração
Public Function HitTest ( _
    clipRectangle As RectangleD, _
    requireCompleteContainment As Boolean _
) As ICollection
public ICollection HitTest(
    RectangleD clipRectangle,
    bool requireCompleteContainment
)
public:
ICollection^ HitTest(
    RectangleD clipRectangle, 
    bool requireCompleteContainment
)
member HitTest : 
        clipRectangle:RectangleD * 
        requireCompleteContainment:bool -> ICollection 
public function HitTest(
    clipRectangle : RectangleD, 
    requireCompleteContainment : boolean
) : ICollection

Parameters

  • 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

See Also

Reference

Diagram Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace