.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

PivotTable.ColumnFields Property

Provides access to the collection of fields located in the column axis area of the PivotTable report.

Namespace: DevExpress.Spreadsheet

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

Declaration

PivotFieldReferenceCollection ColumnFields { get; }
ReadOnly Property ColumnFields As PivotFieldReferenceCollection

Property Value

Type Description
PivotFieldReferenceCollection

A PivotFieldReferenceCollection object that represents the collection of column fields.

Remarks

Use the ColumnFields property to get access to the collection that stores all column fields added to the PivotTable report. An individual column field can be accessed by its index or name in the collection.

To add a new column field to the pivot table, use the PivotFieldReferenceCollection.Add method. To add a field to the column area at the specified position, use the PivotFieldReferenceCollection.Insert method.

To remove a column field from the PivotTable report, use the PivotFieldReferenceCollection.Remove or PivotFieldReferenceCollection.RemoveAt method. You can also use the PivotFieldReferenceCollection.Clear method to remove all fields from the PivotTable's column area at once.

Examples

Dim sourceWorksheet As Worksheet = workbook.Worksheets("Data1")
Dim worksheet As Worksheet = workbook.Worksheets.Add()
workbook.Worksheets.ActiveWorksheet = worksheet

' Create a pivot table.
Dim pivotTable As PivotTable = worksheet.PivotTables.Add(sourceWorksheet("A1:D41"), worksheet("B2"))

' Add the "Product" field to the row axis area.
pivotTable.RowFields.Add(pivotTable.Fields("Product"))
' Add the "Category" field to the column axis area.
pivotTable.ColumnFields.Add(pivotTable.Fields("Category"))
' Add the "Sales" field to the data area and specify the custom field name.
Dim dataField As PivotDataField = pivotTable.DataFields.Add(pivotTable.Fields("Sales"), "Sales(Sum)")
' Specify the number format for the "Sales" field.
dataField.NumberFormat = "_([$$-409]* #,##0.00_);_([$$-409]* (#,##0.00);_([$$-409]* "" - ""??_);_(@_)"
' Add the "Region" field to the filter area.
pivotTable.PageFields.Add(pivotTable.Fields("Region"))
See Also