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 > AnnObject Class : HitTest Method



testPoint
The AnnPoint to be tested.
buffer
Threshold buffer value, in pixels.
testPoint
The AnnPoint to be tested.
buffer
Threshold buffer value, in pixels.
Performs hit-testing on this AnnObject.

Syntax

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

Parameters

testPoint
The AnnPoint to be tested.
buffer
Threshold buffer value, in pixels.

Return Value

A value that represents the hit-test value; or null (Nothing in Visual Basic) if the test point is not on top of this AnnObject.

Example

For an example, refer to AnnContainer.

Remarks

This method is called internally by the annotation framework whenever the HitTest method is called. You can call this method on the annotation object returned from HitTest to fine tune the hit-test value if applicable.

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 this AnnObject is invisible (Visible is set to false), this method will return null (Nothing in Visual Basic).

By default, an annotation object will return AnnObject.DefaultHitTestValue if hit-testing was satisfied. Derived objects can override this method to fine tune the return value.

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