PivotTable.BandedColumns Property

Gets or sets a value indicating whether alternate shading should be applied to the pivot table columns.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

bool BandedColumns { get; set; }

VB.NET

Property BandedColumns As Boolean

Property Value

Type	Description
Boolean	true, to apply banded column formatting to the pivot table; otherwise, false.

Remarks

To apply banding to columns in a pivot table, set the BandedColumns property to true.

To change the format of alternate column stripes, modify the TableStyleElementType.FirstColumnStripe and TableStyleElementType.SecondColumnStripe elements of the style applied to a pivot table. The TableStyleElement.StripeSize property of these table style elements allows you to specify the number of pivot table columns to be displayed as odd and even column stripes. You can also specify the borders (TableStyleElement.Borders), background color (TableStyleElement.Fill) and font (TableStyleElement.Font) of column stripes.

The images below demonstrate how the BandedColumns property works.

BandedColumns = false	BandedColumns = true

Example

View Example

PivotTableFormattingActions.cs

Worksheet worksheet = workbook.Worksheets["Report4"];
workbook.Worksheets.ActiveWorksheet = worksheet;

// Access the pivot table by its name in the collection.
PivotTable pivotTable = worksheet.PivotTables["PivotTable1"];
// Apply the banded column formatting to the pivot table. 
pivotTable.BandedColumns = true;

PivotTableFormattingActions.vb

Dim worksheet As Worksheet = workbook.Worksheets("Report4")
workbook.Worksheets.ActiveWorksheet = worksheet

' Access the pivot table by its name in the collection.
Dim pivotTable As PivotTable = worksheet.PivotTables("PivotTable1")
' Apply the banded column formatting to the pivot table. 
pivotTable.BandedColumns = True

Related GitHub Examples

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

spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/CodeExamples/PivotTableFormattingActions.cs#L31

// Apply the banded column formatting to the pivot table.
pivotTable.BandedColumns = true;
#endregion #BandedColumns

wpf-spreadsheet-pivot-table-api-examples/CS/SpreadsheetWPFPivotTableExamples/CodeExamples/PivotTableFormattingActions.cs#L31

// Apply the banded column formatting to the pivot table.
pivotTable.BandedColumns = true;
#endregion #BandedColumns

winforms-spreadsheet-pivot-table-api/CS/SpreadsheetPivotTableExamples/CodeExamples/PivotTableFormattingActions.cs#L31

// Apply the banded column formatting to the pivot table.
pivotTable.BandedColumns = true;
#endregion #BandedColumns

VB.NET

spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/CodeExamples/PivotTableFormattingActions.vb#L31

            ' Apply the banded column formatting to the pivot table.
            pivotTable.BandedColumns = True
'            #End Region ' #BandedColumns

wpf-spreadsheet-pivot-table-api-examples/VB/SpreadsheetWPFPivotTableExamples/CodeExamples/PivotTableFormattingActions.vb#L31

            ' Apply the banded column formatting to the pivot table.
            pivotTable.BandedColumns = True
'            #End Region ' #BandedColumns

winforms-spreadsheet-pivot-table-api/VB/SpreadsheetPivotTableExamples/CodeExamples/PivotTableFormattingActions.vb#L31

            ' Apply the banded column formatting to the pivot table.
            pivotTable.BandedColumns = True
'            #End Region ' #BandedColumns