NavBarCalcGroupClientHeightEventArgs.Height Property

Gets or sets the group’s client area height.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v19.1.dll

Declaration

C#

public int Height { get; set; }

VB.NET

Public Property Height As Integer

Property Value

Type	Description
Int32	An integer value specifying the height of the group’s client area in pixels.

Remarks

When the NavBarGroup.CalcGroupClientHeight event is invoked, the automatically calculated group client area height is assigned to the Height property. Assign a value to this property to implement custom height for the group’ client area.

Example

The following sample code handles the NavBarControl.CustomDrawGroupClientForeground event to custom paint the text on a group’s client foreground. The group doesn’t contain any links initially and thus the NavBarGroup.CalcGroupClientHeight event is handled to specify the group’s height.

The image below shows the result.

C#

using DevExpress.XtraNavBar.ViewInfo;
using DevExpress.XtraNavBar;

private void navBarControl1_CustomDrawGroupClientForeground(object sender, 
  CustomDrawObjectEventArgs e) {
   // Identifying the processed group.
   NavGroupClientInfoArgs info = e.ObjectInfo as NavGroupClientInfoArgs;
   if (info.Group.Caption != "Support Info") return;

   // Specifying the text rectangle.    
   Rectangle rect = e.RealBounds;
   rect.Height /= 4;

   // Creating a brush object.
   SolidBrush textBrush = new SolidBrush(Color.Black);

   // Formatting the output string.
   StringFormat outStringFormat = new StringFormat();
   outStringFormat.Alignment = StringAlignment.Near;
   outStringFormat.LineAlignment = StringAlignment.Center;

   // Painting the first string.
   rect.Offset(0, rect.Height);
   using(textBrush) {
      e.Graphics.DrawString("E-mail:", new Font("Verdana", 8, FontStyle.Bold), 
        textBrush, rect, outStringFormat);

      // Painting the second string.
      rect.Offset(0, rect.Height);
      e.Graphics.DrawString("[e-mail]", new Font("Verdana", 8), 
        textBrush, rect, outStringFormat);
   }

   // Prohibiting default painting.
   e.Handled = true;
}

private void navBarGroup2_CalcGroupClientHeight(object sender, 
  NavBarCalcGroupClientHeightEventArgs e) {
   e.Height = 70;        
}

VB.NET

Imports DevExpress.XtraNavBar.ViewInfo
Imports DevExpress.XtraNavBar

Private Sub NavBarControl1_CustomDrawGroupClientForeground(ByVal sender As Object, _
  ByVal e As CustomDrawObjectEventArgs) _
  Handles NavBarControl1.CustomDrawGroupClientForeground
    ' Identifying the processed group.
    Dim info As NavGroupClientInfoArgs = CType(e.ObjectInfo, NavGroupClientInfoArgs)
    If info.Group.Caption <> "Support Info" Then Exit Sub

    ' Specifying the text rectangle.
    Dim Rect As New RectangleF(e.RealBounds.Left, e.RealBounds.Top, _
      e.RealBounds.Width, e.RealBounds.Height)
    Rect.Height /= 4

    ' Creating a brush object.
    Dim TextBrush As New SolidBrush(Color.Black)

    ' Formatting the output string.
    Dim OutStringFormat As New StringFormat()
    OutStringFormat.Alignment = StringAlignment.Near
    OutStringFormat.LineAlignment = StringAlignment.Center

    ' Painting the first string.
    Rect.Offset(0, Rect.Height)
    e.Graphics.DrawString("E-mail:", New Font("Verdana", 8, FontStyle.Bold), TextBrush, _
      Rect, OutStringFormat)

    ' Painting the second string.
    Rect.Offset(0, Rect.Height)
    e.Graphics.DrawString("[e-mail]", New Font("Verdana", 8), TextBrush, _
      Rect, OutStringFormat)
    TextBrush.Dispose()

    ' Prohibiting default painting.
    e.Handled = True
End Sub

Private Sub NavBarGroup2_CalcGroupClientHeight(ByVal sender As System.Object, _
  ByVal e As NavBarCalcGroupClientHeightEventArgs) Handles NavBarGroup6.CalcGroupClientHeight
   e.Height = 70
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Height 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.

C#

forcing-the-group-control-container-to-adjust-its-size-according-to-the-navbars-empty-area-e763/CS/WindowsApplication29/Form1.cs#L391

    int ch = vi.Client.Height - delta - gi.Bounds.Height - footerHeight;
    e.Height = ch;
}

VB.NET

forcing-the-group-control-container-to-adjust-its-size-according-to-the-navbars-empty-area-e763/VB/WindowsApplication29/Form1.vb#L367

    Dim ch As Integer = vi.Client.Height - delta - gi.Bounds.Height - footerHeight
    e.Height = ch
End Sub