PivotGridControl.ShowingEditor Event

Allows you to cancel editor activation.

Namespace : DevExpress.XtraPivotGrid

Assembly : DevExpress.XtraPivotGrid.v25.2.dll

NuGet Package : DevExpress.Win.PivotGrid

Declaration

• C#
• VB.NET

public event EventHandler<CancelPivotCellEditEventArgs> ShowingEditor

Public Event ShowingEditor As EventHandler(Of CancelPivotCellEditEventArgs)

Event Data

The ShowingEditor event's data class is CancelPivotCellEditEventArgs. The following properties provide information specific to this event:

The event data class exposes the following methods:

Remarks

The ShowingEditor event is raised before a cell editor is activated, and allows you to cancel the operation. To do this, set the event parameter’s CancelPivotCellEditEventArgs.Cancel property to true.

After the editor has been invoked, the PivotGridControl.ShownEditor event fires.

Use the following event parameter’s properties to identify the cell where the editor is about to be invoked:

• 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).

Example

The following code shows how to disable data editing for total cells. This is accomplished by handling the PivotGridControl.ShowingEditor event. When handling this event, the type of the current cell can be identified via the PivotCellEventArgsBase<TField, TData, TCustomTotal>.ColumnValueType and PivotCellEventArgsBase<TField, TData, TCustomTotal>.RowValueType parameters.

• C#
• VB.NET

using DevExpress.XtraPivotGrid;

private void pivotGridControl1_ShowingEditor(object sender, CancelPivotCellEditEventArgs e) {
    if (e.RowValueType != PivotGridValueType.Value || e.ColumnValueType != PivotGridValueType.Value)
        e.Cancel = true;
}

Imports DevExpress.XtraPivotGrid

Private Sub PivotGridControl1_ShowingEditor(ByVal sender As System.Object, _
ByVal e As CancelPivotCellEditEventArgs) Handles PivotGridControl1.ShowingEditor
    If e.RowValueType <> PivotGridValueType.Value OrElse e.ColumnValueType <> PivotGridValueType.Value Then
        e.Cancel = True
    End If
End Sub

See Also

FieldEdit

ShowEditor

PivotGridOptionsCustomizationEx.AllowEdit

PivotGridFieldOptionsEx.AllowEdit

Cell Editors Overview

PivotGridControl Class

PivotGridControl Members

DevExpress.XtraPivotGrid Namespace