How to: Custom Paint the Group's Client Foreground

• Aug 01, 2019
• 2 minutes to read

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