XtraTabbedMdiManager.CustomDrawHeaderButton Event

Allows you to draw a header button manually.

Namespace: DevExpress.XtraTabbedMdi

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Appearance")]
public event HeaderButtonCustomDrawEventHandler CustomDrawHeaderButton

VB.NET

<DXCategory("Appearance")>
Public Event CustomDrawHeaderButton As HeaderButtonCustomDrawEventHandler

Event Data

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

Property	Description
Bounds	Gets the rectangle that specifies the bounds of the header button.
Button	Gets the button that is being drawn.
Cache	Provides access to the drawing surface and a cache of pens, fonts, and brushes. Inherited from ObjectCustomDrawEventArgs.
Graphics	Provides access to the drawing surface. Inherited from ObjectCustomDrawEventArgs.
Handled	Gets or sets whether the event is handled and prevents the default draw operation from being performed. Inherited from ObjectCustomDrawEventArgs.
Info	Provides access to the object that contains information about the button being drawn.
IsDefaultDrawInProgress	Inherited from ObjectCustomDrawEventArgs.
Painter	Provides access to the object that performs paint operations. Inherited from ObjectCustomDrawEventArgs.

The event data class exposes the following methods:

Method	Description
DefaultDraw()	Inherited from ObjectCustomDrawEventArgs.
DrawHtml(HtmlTemplate, DxHtmlPainterContext, Action<DxHtmlPainterArgs>)	Paints the required HTML template inside an element that raised this event. The context parameter allows you to assign an object that transfers mouse events to template elements. Inherited from ObjectCustomDrawEventArgs.
DrawHtml(HtmlTemplate, Action<DxHtmlPainterArgs>)	Paints the required HTML template inside an element that raised this event. Inherited from ObjectCustomDrawEventArgs.

Example

The code below shows how to draw a custom background in tab headers and header buttons.

C#

using System.Drawing.Drawing2D;

HatchBrush myHatchBrush2 = new HatchBrush(HatchStyle.DiagonalCross, Color.LightGray, Color.AliceBlue);
private void XtraTabbedMdiManager1_CustomDrawHeaderButton(object sender, XtraTab.HeaderButtonCustomDrawEventArgs e) {
    e.Cache.FillRectangle(myHatchBrush2, e.Bounds);
    e.DefaultDraw();
    e.Handled = true;
}

HatchBrush myHatchBrush1 = new HatchBrush(HatchStyle.BackwardDiagonal, Color.LightGray, Color.AliceBlue);
private void XtraTabbedMdiManager1_CustomDrawTabHeader(object sender, XtraTab.TabHeaderCustomDrawEventArgs e) {
    e.Cache.FillRectangle(myHatchBrush1, e.Bounds);
    e.DefaultDrawText();
    e.DefaultDrawImage();
    e.DefaultDrawButtons();
    e.Handled = true;
}

VB.NET

Imports System.Drawing.Drawing2D

Private myHatchBrush2 As New HatchBrush(HatchStyle.DiagonalCross, Color.LightGray, Color.AliceBlue)
Private Sub XtraTabbedMdiManager1_CustomDrawHeaderButton(ByVal sender As Object, ByVal e As XtraTab.HeaderButtonCustomDrawEventArgs) _
    Handles xtraTabbedMdiManager1.CustomDrawHeaderButton
    e.Cache.FillRectangle(myHatchBrush2, e.Bounds)
    e.DefaultDraw()
    e.Handled = True
End Sub

Private myHatchBrush1 As New HatchBrush(HatchStyle.BackwardDiagonal, Color.LightGray, Color.AliceBlue)
Private Sub XtraTabbedMdiManager1_CustomDrawTabHeader(ByVal sender As Object, ByVal e As XtraTab.TabHeaderCustomDrawEventArgs) _
    Handles xtraTabbedMdiManager1.CustomDrawTabHeader
    e.Cache.FillRectangle(myHatchBrush1, e.Bounds)
    e.DefaultDrawText()
    e.DefaultDrawImage()
    e.DefaultDrawButtons()
    e.Handled = True
End Sub