GroupControl.CustomDrawCaption Event

Enables group caption to be custom painted.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.Utils.v18.1.dll

Declaration

C#

[DXCategory("Appearance")]
public event GroupCaptionCustomDrawEventHandler CustomDrawCaption

VB.NET

<DXCategory("Appearance")>
Public Event CustomDrawCaption As GroupCaptionCustomDrawEventHandler

Event Data

The CustomDrawCaption event's data class is GroupCaptionCustomDrawEventArgs. The following properties provide information specific to this event:

Property	Description
CaptionBounds	Gets the painted caption’s bounding rectangle.
Info	Gets information on the painted group.

The event data class exposes the following methods:

Method	Description
DefaultDraw()	Performs default painting of this element.

Remarks

This event is raised each time a group caption needs to be repainted and it provides the ability to paint it manually. All the information required to paint the group caption can be obtained via the event parameter’s GroupCaptionCustomDrawEventArgs.Info property. Note that the Handled parameter must be set to true to prohibit the default painting.

Example

The following example demonstrates how to handle the GroupControl.CustomDrawCaption event to manually paint a group control’s caption.

The image below shows the result.

C#

using System.Drawing.Drawing2D;
using DevExpress.XtraEditors;
// ...

private void groupControl1_CustomDrawCaption(object sender, GroupCaptionCustomDrawEventArgs e) {
   LinearGradientBrush outerBrush = new LinearGradientBrush(e.CaptionBounds, 
     Color.LightBlue, Color.Blue, LinearGradientMode.Vertical);
   using(outerBrush) {
      e.Graphics.FillRectangle(outerBrush, e.CaptionBounds);
   }

   Rectangle innerRect = Rectangle.Inflate(e.CaptionBounds, -3, -3);
   LinearGradientBrush innerBrush = new LinearGradientBrush(innerRect, Color.Blue, 
     Color.LightBlue, LinearGradientMode.Vertical);
   using(innerBrush) {
      e.Graphics.FillRectangle(innerBrush, e.CaptionBounds);
   }

   StringFormat outStrFormat = new StringFormat();
   outStrFormat.Alignment = StringAlignment.Center;
   outStrFormat.LineAlignment = StringAlignment.Center;
   e.Graphics.DrawString(e.Info.Caption, e.Info.AppearanceCaption.Font, 
     e.Cache.GetSolidBrush(Color.White), innerRect, outStrFormat);

   e.Handled = true;
}

VB.NET

Imports System.Drawing.Drawing2D
Imports DevExpress.XtraEditors
' ...

Private Sub GroupControl1_CustomDrawCaption(ByVal sender As Object, _
ByVal e As GroupCaptionCustomDrawEventArgs) _
Handles GroupControl1.CustomDrawCaption
   Dim outerBrush As LinearGradientBrush = New LinearGradientBrush(e.CaptionBounds, _
     Color.LightBlue, Color.Blue, LinearGradientMode.Vertical)
   e.Graphics.FillRectangle(outerBrush, e.CaptionBounds)
   outerBrush.Dispose()

   Dim innerRect As Rectangle = Rectangle.Inflate(e.CaptionBounds, -3, -3)
   Dim innerBrush As LinearGradientBrush = New LinearGradientBrush(innerRect, _
     Color.Blue, Color.LightBlue, LinearGradientMode.Vertical)
   e.Graphics.FillRectangle(innerBrush, e.CaptionBounds)
   innerBrush.Dispose()

   Dim textRect As New RectangleF(innerRect.Left, innerRect.Top, _
     innerRect.Width, innerRect.Height)
   Dim outStrFormat As StringFormat = New StringFormat()
   outStrFormat.Alignment = StringAlignment.Center
   outStrFormat.LineAlignment = StringAlignment.Center
   e.Graphics.DrawString(e.Info.Caption, e.Info.AppearanceCaption.Font, _
     e.Cache.GetSolidBrush(Color.White), textRect, outStrFormat)

   e.Handled = True
End Sub