BandedGridHitInfo.Band Property

Gets the band located under the test point.

Namespace: DevExpress.XtraGrid.Views.BandedGrid.ViewInfo

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public GridBand Band { get; set; }

VB.NET

Public Property Band As GridBand

Property Value

Type	Description
GridBand	A GridBand object representing the band located under the test point.

Remarks

The Band property returns a band object in the following cases:

• the test point is over a band header;
• the test point is over a data cell displayed within a column that belongs to a band.

In all other cases, the Band property returns null (Nothing in Visual Basic).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

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

if (hitInfo.HitTest == BandedGridHitTest.Band) {
    GridBandInfoArgs bandInfo = view.ViewInfo.BandsInfo[hitInfo.Band];
    if (CalcButtonBounds(bandInfo.Bounds).Contains(e.X, e.Y)) {

how-to-select-cells-under-by-clicking-the-gridband-or-the-column-header-e490/CS/Q130069/Form1.cs#L27

}
else if (hInfo.InBandPanel && hInfo.Band != null)
{

how-to-resize-columns-in-the-advbandedgridview-when-band-headers-are-hidden-e1416/CS/Q203466/MyBandedView.cs#L56

GridBand ownerBand = (hit as BandedGridHitInfo).Column.OwnerBand;
hi.Band = ownerBand;
hi.HitTest = BandedGridHitTest.BandEdge;

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

BandedGridHitInfo hi = _View.CalcHitInfo(e.Location);
if (_Bands.Contains(hi.Band) && hi.InRowCell == false)
    DXMouseEventArgs.GetMouseArgs(e).Handled = true;

VB.NET

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

If hitInfo.HitTest = BandedGridHitTest.Band Then
    Dim bandInfo As GridBandInfoArgs = view.ViewInfo.BandsInfo(hitInfo.Band)
    If CalcButtonBounds(bandInfo.Bounds).Contains(e.X, e.Y) Then

how-to-select-cells-under-by-clicking-the-gridband-or-the-column-header-e490/VB/Q130069/Form1.vb#L25

    SelectCells(hInfo.Column)
ElseIf hInfo.InBandPanel AndAlso hInfo.Band IsNot Nothing Then
    view.ClearSelection()

how-to-resize-columns-in-the-advbandedgridview-when-band-headers-are-hidden-e1416/VB/dxt2/MyBandedView.vb#L54

Dim ownerBand As GridBand = (TryCast(hit, BandedGridHitInfo)).Column.OwnerBand
hi.Band = ownerBand
hi.HitTest = BandedGridHitTest.BandEdge

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

Dim hi As BandedGridHitInfo = _View.CalcHitInfo(e.Location)
If _Bands.Contains(hi.Band) AndAlso hi.InRowCell = False Then
    DXMouseEventArgs.GetMouseArgs(e).Handled = True