PivotCellEditEventArgs Class

Provides data for the PivotGridControl.HiddenEditor and PivotGridControl.ShownEditor events.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.2.dll

Declaration

C#

public class PivotCellEditEventArgs :
    PivotCellBaseEventArgs

VB.NET

Public Class PivotCellEditEventArgs
    Inherits PivotCellBaseEventArgs

Related API Members

PivotCellEditEventArgs is the data class for the following events:

• PivotGridControl.HiddenEditor
• PivotGridControl.ShownEditor

Remarks

The PivotGridControl.HiddenEditor and PivotGridControl.ShownEditor events are raised after an editor has been closed or invoked, respectively.

The PivotCellEditEventArgs provides the PivotCellEditEventArgs.Edit property used to obtain the processed editor.

Use the following PivotCellEditEventArgs properties to identify a particular cell whose editor has been invoked or closed.

• The PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnField, PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowField and PivotCellEventArgsBase<TField, TData, TCustomTotal>.DataField properties return column, row and data fields that correspond to the processed cell, respectively.
• The PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnIndex and PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowIndex properties return indexes of the column and row where the processed cell resides, respectively.
• The PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnValueType and PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowValueType properties return types of the column and row where the processed cell resides, respectively.
• If the processed cell is a custom total cell, the PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnCustomTotal and PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowCustomTotal properties return column and row custom totals that contain the processed cell, respectively. Otherwise, these properties return null (Nothing in Visual Basic).

Inheritance

Object

EventArgs

PivotCellEventArgsBase<PivotGridField, DevExpress.XtraPivotGrid.Data.PivotGridViewInfoData, PivotGridCustomTotal>

PivotCellBaseEventArgs

PivotCellEditEventArgs