PivotCustomSummaryEventArgs.ColumnField Property

Gets the column field that corresponds to the current cell.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v24.2.dll

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public PivotGridField ColumnField { get; }

VB.NET

Public ReadOnly Property ColumnField As PivotGridField

Property Value

Type	Description
PivotGridField	A PivotGridField object, which is the column field that corresponds to the current cell.

Remarks

When PivotGridControl is in the Asynchronous Mode, the PivotGridControl.CustomSummary event is handled in a background thread. In this instance, the ColumnField property does not guarantee thread safety when accessing the processed field. If you try to use the ColumnField property in the Asynchronous Mode, an exception will be thrown. Use the PivotCustomSummaryEventArgs.ThreadSafeColumnField property to access the field thread safely.

Related GitHub Examples

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

wpf-pivot-grid-provide-custom-summary-values/CS/WpfApplication1/CustomTotalGrandTotalBehavior.cs#L23

{
    if ((e.ColumnField == null) || (e.RowField == null))
    {

VB.NET

wpf-pivot-grid-provide-custom-summary-values/VB/WpfApplication1/CustomTotalGrandTotalBehavior.vb#L23

If Equals(e.DataField.Name, Name) Then
    If e.ColumnField Is Nothing OrElse e.RowField Is Nothing Then
        'this is Grand Total cell