LEADTOOLS Annotations (Leadtools.Annotations assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
NameHitTest Method
See Also 
Leadtools.Annotations Namespace > AnnObject Class : NameHitTest Method



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

The NameHitTest Method is available in LEADTOOLS Document and Medical Imaging toolkits.

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

Syntax

Visual Basic (Declaration) 
Protected Overridable Function NameHitTest( _
   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.NameHitTest(testPoint, buffer)
C# 
protected virtual object NameHitTest( 
   AnnPoint testPoint,
   int buffer
)
C++/CLI 
protected:
virtual Object^ NameHitTest( 
   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 name.

Remarks

This method is called internally by the annotation framework whenever the AnnObject.HitTest method is called. You do not need to call this property directly.

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 the name of this object is invisible (AnnObject.NameVisible is set to false), this method will not be called.

By default, an annotation object will return NameHitTestValue if hit-testing the name was satisfied

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

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