PivotFieldFilterChangingEventArgs Class

Provides data for the PivotGridControl.FieldFilterChanging event.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v17.2.dll

Declaration

C#

public class PivotFieldFilterChangingEventArgs :
    PivotFieldEventArgs

VB.NET

Public Class PivotFieldFilterChangingEventArgs
    Inherits PivotFieldEventArgs

Related API Members

PivotFieldFilterChangingEventArgs is the data class for the following events:

• PivotGridControl.FieldFilterChanging

Remarks

The PivotGridControl.FieldFilterChanging event occurs when a field’s filter condition is about to be changed, allowing you to cancel this action. The PivotFieldFilterChangingEventArgs class provides the PivotFieldFilterChangingEventArgs.Values property that returns the collection of filter values that are about to be assigned to the filter’s PivotGridFieldFilterValues.Values property. To cancel this action, set the PivotFieldFilterChangingEventArgs.Cancel property to true. You can also obtain the field for which the filter condition is being changed, and the current filter type, using the event parameter’s PivotFieldEventArgsBase<T>.Field and PivotFieldFilterChangingEventArgs.FilterType properties, respectively.

Related GitHub Examples

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

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-prevent-end-users-from-changing-the-filter-condition-e2397/CS/HowToCancelFilterChange/Form1.cs#L14

private void pivotGridControl1_FieldFilterChanging(object sender,
        PivotFieldFilterChangingEventArgs e) {
    if(object.ReferenceEquals(e.Field, fieldCategoryName)) {

VB.NET

how-to-prevent-end-users-from-changing-the-filter-condition-e2397/VB/HowToCancelFilterChange/Form1.vb#L16

Private Sub pivotGridControl1_FieldFilterChanging(ByVal sender As Object, _
                                                  ByVal e As PivotFieldFilterChangingEventArgs) _
                                              Handles pivotGridControl1.FieldFilterChanging

Inheritance

Object

EventArgs

PivotFieldEventArgsBase<PivotGridField>

PivotFieldEventArgs

PivotFieldFilterChangingEventArgs