PivotSummaryFilter.Apply(Object, Object, PivotGridFieldBase, PivotGridFieldBase) Method

Applies the summary filter with the specified range of values to be displayed. The filter is applied to cells that belong to the specified aggregation level.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v20.2.Core.dll

Declaration

public void Apply(
    object startValue,
    object endValue,
    PivotGridFieldBase rowField,
    PivotGridFieldBase columnField
)
Public Sub Apply(
    startValue As Object,
    endValue As Object,
    rowField As PivotGridFieldBase,
    columnField As PivotGridFieldBase
)

Parameters

Name Type Description
startValue Object

The minimum value to be displayed. This value is assigned to the PivotSummaryFilter.StartValue property.

endValue Object

The maximum value to be displayed. This value is assigned to the PivotSummaryFilter.EndValue property.

rowField PivotGridFieldBase

A PivotGridFieldBase descendant that specifies the row field used to identify the target aggregation level. This value is assigned to the PivotSummaryFilter.RowField property.

columnField PivotGridFieldBase

A PivotGridFieldBase descendant that specifies the column field used to identify the target aggregation level. This value is assigned to the PivotSummaryFilter.ColumnField property.

Remarks

This overload of the Apply method applies summary filtering to cells that belong to the specified aggregation level. To do this, it sets the PivotSummaryFilter.Mode property to the PivotSummaryFilterMode.SpecificLevel.

As an alternative to calling the Apply method, you can use properties exposed by the PivotSummaryFilter object to configure and apply summary filtering. See Filtering by Summaries for more information.

See Also