NavBarControl.CalcHitInfo(Point) Method

Gets an object containing information about the control at a specified point.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v19.2.dll

Declaration

C#

public virtual NavBarHitInfo CalcHitInfo(
    Point p
)

VB.NET

Public Overridable Function CalcHitInfo(
    p As Point
) As NavBarHitInfo

Parameters

Name	Type	Description
p	Point	A System.Drawing.Point object specifying the examined point.

Returns

Type	Description
NavBarHitInfo	A NavBarHitInfo object providing information about the control’s specified point.

Remarks

Use the CalcHitInfo method to determine control elements over which a specified point resides and obtain objects representing these elements. Review the NavBarHitInfo class description for more details on information it provides.

Example

The following sample code represents a handler for the MouseMove event. It calculates hit information for the mouse pointer’s position via the NavBarControl.CalcHitInfo method. Then, the type of the element that is hovered over is assigned to a string variable.

C#

private void navBarControl1_MouseMove(object sender, MouseEventArgs e) {
   // calculating hit information by the current mouse pointer position
   NavBarHitInfo hitInfo = navBarControl1.CalcHitInfo(new Point(e.X, e.Y));
   // obtaining the type of the element which is under the mouse pointer
   string element = hitInfo.HitTest.ToString();
   // ...
}

VB.NET

Private Sub NavBarControl1_MouseMove(ByVal sender As Object, _
  ByVal e As MouseEventArgs) Handles NavBarControl1.MouseMove
   ' calculating hit information by the current mouse pointer position
   Dim HitInfo As NavBarHitInfo = NavBarControl1.CalcHitInfo(New Point(e.X, e.Y))
   ' obtaining the type of the element which is under the mouse pointer
   Dim Element As String = HitInfo.HitTest.ToString()
   ' ...
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CalcHitInfo(Point) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

how-to-provide-supertooltip-with-design-time-support-for-any-control-e2311/VB/E2311/Helper/MyNavBarSuperTipHelper.vb#L25

If navBar IsNot Nothing Then
    Dim hi As NavBarHitInfo = navBar.CalcHitInfo(e.ControlMousePosition)

which-event-to-use-when-collapsing-expanding-the-groups-in-the-navbars-explorer-views-e782/VB/Form1.vb#L121

If e.Button = MouseButtons.Left Then
    Dim info As NavBarHitInfo = (TryCast(sender, NavBarControl)).CalcHitInfo(New Point(e.X, e.Y))
    If info.InGroupButton AndAlso (Not info.Group.Expanded) Then

how-to-add-a-checkbox-to-the-navbar-groups-caption-e2061/VB/WindowsApplication1/NavBarGroupStateHelper.vb#L133

Private Function IsCheckBox(ByVal p As Point) As Boolean
    Dim hi As NavBarHitInfo = NavBarControl.CalcHitInfo(p)
    If hi.Group Is Nothing Then

C#

which-event-to-use-when-collapsing-expanding-the-groups-in-the-navbars-explorer-views-e782/CS/Form1.cs#L127

if(e.Button == MouseButtons.Left) {
    NavBarHitInfo info = (sender as NavBarControl).CalcHitInfo(new Point(e.X, e.Y));
    if(info.InGroupButton && !info.Group.Expanded) {

how-to-add-a-checkbox-to-the-navbar-groups-caption-e2061/CS/WindowsApplication1/NavBarGroupStateHelper.cs#L135

{
    NavBarHitInfo hi = NavBarControl.CalcHitInfo(p);
    if (hi.Group == null) return false; ;

how-to-show-the-navpaneform-programmatically-e2199/CS/WindowsApplication1/Form1.cs#L43

var args = (MouseEventArgs)e;
var hi = navBarControl1.CalcHitInfo(args.Location);
if (hi.InGroupCaption && hi.Group == navBarControl1.ActiveGroup)