C1.Win.C1Command.C1TopicBar.HitTest

HitTest Method

HitTest()

Returns information about the control at at the current mouse position.

Declaration

public C1TopicBarHitTestInfo HitTest()

Returns

Type	Description
C1TopicBarHitTestInfo	A C1TopicBarHitTestInfo object that contains information about the point.

HitTest(int, int)

Returns information about the control at a specified point on the control surface.

Declaration

public C1TopicBarHitTestInfo HitTest(int x, int y)

Parameters

Type	Name	Description
int	x	The horizontal position of the client coordinate.
int	y	The vertical position of the client coordinate.

Returns

Type	Description
C1TopicBarHitTestInfo	A C1TopicBarHitTestInfo object that contains information about the point.

Remarks

This method is useful when handling the MouseMove, MouseDown events or similar. It allows you to determine whether the mouse is over a specific link, page title, etc.

HitTest(Point)

Returns information about the control at a specified point on the control surface.

Declaration

public C1TopicBarHitTestInfo HitTest(Point p)

Parameters

Type	Name	Description
Point	p	Point in client coordinates.

Returns

Type	Description
C1TopicBarHitTestInfo	A C1TopicBarHitTestInfo object that contains information about the point.

Remarks

This method is useful when handling the MouseMove, MouseDown events or similar. It allows you to determine whether the mouse is over a specific link, page title, etc.

Examples

The code below shows hit test information whenever the user moves the mouse:

Private Sub C1TopicBar1_MouseMove(ByVal sender As System.Object, ByVal e As System.Windows.Forms.MouseEventArgs) Handles C1TopicBar1.MouseMove
Dim ht As C1.Win.C1Command.C1TopicBarHitTestInfo = C1TopicBar1.HitTest(e.Location)
Label1.Text = ht.Type.ToString()
If (Not IsNothing(ht.Page)) Then
   Label2.Text = ht.Page.Text
Else
   Label2.Text = ""
End If
If (Not IsNothing(ht.Link)) Then
   Label3.Text = ht.Link.Text
Else
   Label3.Text = ""
End If
End Sub