PivotCustomDrawCellBaseEventArgs.ColumnField Property

Gets the innermost column field that corresponds to the current cell.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

C#

public PivotGridField ColumnField { get; }

VB.NET

Public ReadOnly Property ColumnField As PivotGridField

Property Value

Type	Description
PivotGridField	A PivotGridField object that specifies the column field.

Remarks

If the current cell resides within a Column Grand Total, the ColumnField property returns null. Otherwise, this property returns the innermost column field that corresponds to the current cell.

Use the PivotCustomDrawCellBaseEventArgs.GetColumnFields method to obtain all column fields that correspond to the current cell.

To obtain the corresponding row fields, use the PivotCustomDrawCellBaseEventArgs.RowField property and PivotCustomDrawCellBaseEventArgs.GetRowFields method respectively.

To determine which data field identifies the current cell, use the PivotCustomDrawCellBaseEventArgs.DataField property.

Note

If you try to access the ColumnField property while an asynchronous operation is being performed, an exception will be thrown. When the operation is in progress, use the PivotCustomDrawCellBaseThreadSafeEventArgs.ColumnField property exposed by a thread-safe event parameter instead. To access the thread-safe event parameter, use the PivotCustomDrawCellBaseEventArgs.ThreadSafeArgs property. To determine whether an asynchronous operation is being performed, use the pivot grid’s IThreadSafeAccessible.IsAsyncInProgress property. For more information, see Asynchronous Mode.

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#

how-to-set-colors-for-the-even-odd-groups-of-cell-based-on-the-high-level-field-values-e2399/CS/WindowsApplication53/Form1.cs#L69

{
    if (object.ReferenceEquals(e.ColumnField, fieldDate) && fieldValueEnumerator != null )
    {

VB.NET

how-to-set-colors-for-the-even-odd-groups-of-cell-based-on-the-high-level-field-values-e2399/VB/WindowsApplication53/Form1.vb#L64

Private Sub pivotGridControl1_CustomAppearance(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PivotCustomAppearanceEventArgs) Handles pivotGridControl1.CustomAppearance
    If Object.ReferenceEquals(e.ColumnField, fieldDate) AndAlso fieldValueEnumerator IsNot Nothing Then
        If fieldValueEnumerator.IndexOf(e.GetFieldValue(fieldYear)) Mod 2 > 0 Then