BandHeaderCustomDrawEventArgs Class

Provides data for the BandedGridView.CustomDrawBandHeader event.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v18.1.dll

Declaration

C#

public class BandHeaderCustomDrawEventArgs :
    CustomDrawObjectEventArgs

VB.NET

Public Class BandHeaderCustomDrawEventArgs
    Inherits CustomDrawObjectEventArgs

Related API Members

BandHeaderCustomDrawEventArgs is the data class for the following events:

• BandedGridView.CustomDrawBandHeader

Remarks

The BandedGridView.CustomDrawBandHeader event fires before a band header is painted. It enables you to paint band headers manually or modify their appearance settings before they are painted using the default mechanism. BandHeaderCustomDrawEventArgs class properties allow you to identify the band whose header is being painted and provide settings common to all custom painting events. Refer to the Custom Painting Basics help topic for details.

Related GitHub Examples

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

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#

how-to-create-a-custom-view-allowing-collapsing-of-band-headers-e2433/CS/BandedViewBandDefaultColumn/BandedViewBandDefaultColumn/MyBandedGridView.cs#L34

private Rectangle CalcCaptionRectWithButton(BandHeaderCustomDrawEventArgs e, bool addButtonWidth) {
    Rectangle captionRect = e.Info.CaptionRect;

bandedgridview-how-to-hide-particular-bands-e3175/CS/BandedGridViewHideBands/MyPaintHelper.cs#L49

void _View_CustomDrawBandHeader(object sender, BandHeaderCustomDrawEventArgs e) {
    if (_Bands.Contains(e.Band))

VB.NET

how-to-create-a-custom-view-allowing-collapsing-of-band-headers-e2433/VB/BandedViewBandDefaultColumn/BandedViewBandDefaultColumn/MyBandedGridView.vb#L36

Private Function CalcCaptionRectWithButton(ByVal e As BandHeaderCustomDrawEventArgs, ByVal addButtonWidth As Boolean) As Rectangle
    Dim captionRect As Rectangle = e.Info.CaptionRect

bandedgridview-how-to-hide-particular-bands-e3175/VB/BandedGridViewHideBands/MyPaintHelper.vb#L53

Private Sub _View_CustomDrawBandHeader(ByVal sender As Object, ByVal e As BandHeaderCustomDrawEventArgs)
    If _Bands.Contains(e.Band) Then

Inheritance

Object

EventArgs

CustomDrawEventArgs

CustomDrawObjectEventArgs

BandHeaderCustomDrawEventArgs