Leadtools.Annotations Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
HitTest Method
See Also 
Leadtools.Annotations Namespace > AnnContainer Class : HitTest Method



testPoint
The AnnPoint to be tested.
buffer
Threshold buffer value.
testPoint
The AnnPoint to be tested.
buffer
Threshold buffer value.
Retrieves the object at the specified coordinates.

Syntax

Visual Basic (Declaration) 
Public Overridable Function HitTest( _
   ByVal testPoint As AnnPoint, _
   ByVal buffer As Integer _
) As AnnObject
Visual Basic (Usage)Copy Code
Dim instance As AnnContainer
Dim testPoint As AnnPoint
Dim buffer As Integer
Dim value As AnnObject
 
value = instance.HitTest(testPoint, buffer)
C# 
public virtual AnnObject HitTest( 
   AnnPoint testPoint,
   int buffer
)
C++/CLI 
public:
virtual AnnObject^ HitTest( 
   AnnPoint testPoint,
   int buffer
) 

Parameters

testPoint
The AnnPoint to be tested.
buffer
Threshold buffer value.

Return Value

An AnnObject that represents the object at the given screen coordinates; or null (Nothing in Visual Basic) if no object is at the tested location.

Example

For an example, refer to AnnContainer.

Remarks

testPoint should be in physical coordinates.

buffer is 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 pixels 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.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Annotations requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features