PivotCellBaseEventArgs.GetColumnFields() Method

Returns an array of column fields which correspond to the processed cell.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v21.1.dll

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public PivotGridField[] GetColumnFields()

VB.NET

Public Function GetColumnFields As PivotGridField()

Returns

Type	Description
PivotGridField[]	An array of column fields.

Remarks

The PivotGrid control supports multiple column fields. Use the GetColumnFields method to get column fields which correspond to the processed cell. If the cell belongs to a Column Grand Total, the GetColumnFields method returns an empty array (the array’s length is 0).

To get the innermost column field which corresponds to the current cell use the PivotCellBaseEventArgs.ColumnField property. This property’s value matches the value of the last element in the array returned by the GetColumnFields method.

To get any field’s value for the processed cell use the PivotCellBaseEventArgs.GetFieldValue method.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetColumnFields() method.

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-exporter-that-supports-autorowheight-bestfit-and-fittopage-t274241/CS/WpfApplication31/PivotReportGenerator.cs#L75

PivotCellBaseEventArgs pcea = pivot.GetCellInfo(i, 0);
foreach(PivotGridField field in pcea.GetColumnFields())
    sb.AppendFormat("{0} | ", field.GetDisplayText(pcea.GetFieldValue(field)));//add formatting if it's necessary

VB.NET

how-to-create-a-custom-exporter-that-supports-autorowheight-bestfit-and-fittopage-t274241/VB/WpfApplication31/PivotReportGenerator.vb#L81

Dim pcea As PivotCellBaseEventArgs = pivot.GetCellInfo(i, 0)
For Each field As PivotGridField In pcea.GetColumnFields()
    sb.AppendFormat("{0} | ", field.GetDisplayText(pcea.GetFieldValue(field))) 'add formatting if it's necessary