NavBarHitInfo.Group Property

Gets a group over whose area a test point resides.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v19.1.dll

Declaration

C#

public NavBarGroup Group { get; }

VB.NET

Public ReadOnly Property Group As NavBarGroup

Property Value

Type	Description
NavBarGroup	A NavBarGroup object representing the group located under a test point. null (Nothing in Visual Basic) if the test point is not over a control group.

Remarks

Use the NavBarControl.CalcHitInfo method to obtain information about a specified point’s location with respect to the control. If a specified point resides over the group (its caption or client area), the method assigns the NavBarGroup object representing this group to the Group property of the returned NavBarHitInfo object. If a specified point is not over the group, the Group property returns null (Nothing in Visual Basic).

You can determine whether the test point is over a group or group caption via the NavBarHitInfo.InGroup and NavBarHitInfo.InGroupCaption properties respectively.

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 group that is hovered over is accessed.

C#

using DevExpress.XtraNavBar;

private void navBarControl1_MouseMove(object sender, MouseEventArgs e) {
   NavBarHitInfo hitInfo = navBarControl1.CalcHitInfo(new Point(e.X, e.Y));
   if (hitInfo.InGroup) {
      NavBarGroup group = hitInfo.Group;
      // perform operations on the group here
      //...
   }
}

VB.NET

Imports DevExpress.XtraNavBar

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))
   If HitInfo.InGroup Then
      Dim Group As NavBarGroup = HitInfo.Group
      ' perform operations on the group here
      '...
   End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Group property.

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-add-a-checkbox-to-the-navbar-groups-caption-e2061/VB/WindowsApplication1/NavBarGroupStateHelper.vb#L134

Dim hi As NavBarHitInfo = NavBarControl.CalcHitInfo(p)
If hi.Group Is Nothing Then
    Return False

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

If hi.InGroup Then
    Dim superTip As SuperToolTip = GetSuperTipByGroup(hi.Group)
        If e.Info Is Nothing Then

C#

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

NavBarHitInfo hi = NavBarControl.CalcHitInfo(p);
if (hi.Group == null) return false; ;
NavBarViewInfo vi = GetNavBarView(NavBarControl);

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

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