HitTest Method (AnnObject)

public virtual object HitTest( 
   AnnPoint testPoint,
   int buffer
)

'Declaration
 
Public Overridable Function HitTest( _
   ByVal testPoint As AnnPoint, _
   ByVal buffer As Integer _
) As Object

'Usage
 
Dim instance As AnnObject
Dim testPoint As AnnPoint
Dim buffer As Integer
Dim value As Object
 
value = instance.HitTest(testPoint, buffer)

public:
virtual Object^ HitTest( 
   AnnPoint testPoint,
   int buffer
) 

Parameters

testPoint

The AnnPoint to be tested.

buffer

Threshold buffer value, in pixels.

Return Value

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 DefaultHitTestValue if hit-testing was satisfied. Derived objects can override this method to fine tune the return value.

Target Platforms

Reference

AnnObject Class
AnnObject Members