HitTestRect Method

Summary

Performs hit-testing on this AnnContainer at the specified rectangle.

Syntax

Java

Objective-C

WinRT C#

C++

public AnnObject[] HitTestRect( 
   LeadRectD rect 
)

Public Function HitTestRect( _ 
   ByVal rect As Leadtools.LeadRectD _ 
) As Leadtools.Annotations.Core.AnnObject()

public [Leadtools.Annotations.Core.AnnObject[]](annobject.md) HitTestRect(  
   Leadtools.LeadRectD rect 
)

-(LTAnnObjectCollection*)hitTestRect:(LeadRectD)rect;

public AnnObject[] hitTestRect(LeadRectD rect)

 function Leadtools.Annotations.Core.AnnContainer.HitTestRect(  
   rect  
)

public:  
   array<AnnObject^>^ HitTestRect( 
      LeadRectD^ rect 
   )

Parameters

rect
The rectangle to be tested in annotation units (1/720 of an inch).

Return Value

An array of AnnObjects that rect intersects with.

Remarks

HitTestBuffer can be used to make the test point "bigger" to compensate for errors and provide smoother hit-testing. For example, if buffer is 2, a square with a length of 4 units around testPoint will be used to perform the hit-testing.

If more than one object overlaps underneath the test point, the method will return the object on top of the Z-order.

The HitTestBehavior property determines whether any part or the entire object must be contained inside the rect to be considered hit-tested. if the value is AnnHitTestBehavior.Contains, then the entire object must be contained inside the rect to be considered hit-tested. If the value is AnnHitTestBehavior.Intersects, then if any part of the object can be contained inside the rect it is considered to be hit-tested.

Requirements

Target Platforms