BandHeaderCustomDrawEventArgs.Band Property

Gets the band whose header is to be painted. Returns null if an “empty band header” is currently being painted.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public GridBand Band { get; }

VB.NET

Public ReadOnly Property Band As GridBand

Property Value

Type	Description
GridBand	A GridBand object specifying the band whose header is to be painted.

Remarks

When the column auto-width feature is disabled (see GridOptionsView.ColumnAutoWidth), the banded grid View displays an “empty band header” and “empty column header” to the right of data bands and columns.

The GridView.CustomDrawColumnHeader event fires repeatedly for each column header, including the “empty column header”. When this event is fired for the “empty column header”, the event’s Column parameter returns null.

Similarly, the BandedGridView.CustomDrawBandHeader event fires in a banded grid View repeatedly for each band header, including the “empty band header”. When this event is fired for the “empty band header”, the event’s Band parameter returns null.

Related GitHub Examples

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

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

void _View_CustomDrawBandHeader(object sender, BandHeaderCustomDrawEventArgs e) {
    if (_Bands.Contains(e.Band))
        e.Handled = true;

VB.NET

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

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