PivotGridFieldBase.SummaryFilter Property
Gets summary filtering settings.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.PivotGrid.v17.2.Core.dll
Declaration
[Browsable(false)]
[XtraSerializableProperty(XtraSerializationVisibility.Content, XtraSerializationFlags.DefaultValue, 1000)]
public PivotSummaryFilter SummaryFilter { get; }Property Value
| Type | Description |
|---|---|
| PivotSummaryFilter | A PivotSummaryFilter object that encapsulates summary filtering settings. |
Remarks
PivotGridControl allows you to filter its data by summary values. Use the SummaryFilter property to configure filtering by summary values calculated against the current data field.
Use the returned PivotSummaryFilter object to access summary filtering settings.
To enable summary filtering, specify the range of summary values that should be included into the pivot grid. Additionally, provide column and row fields that identify the target data aggregation level if you wish to apply filtering to Total or Grand Total values.
Use one of the following approaches.
- Call the PivotSummaryFilter.Apply method and pass summary filter settings as its parameters.
Assign summary filter settings to the following properties.
Gets or sets the minimum summary value to be displayed.
Gets or sets the maximum summary value to be displayed.
Gets or sets whether summary filtering should be applied to the last aggregation level or to the specified one.
Gets or sets a column field used to identify an aggregation level to which the filtering is applied.
Gets or sets the row field used to identify an aggregation level to which the filtering is applied.
To learn more, see Filtering by Summaries Overview and Using Summary Filters.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SummaryFilter 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.