Skip to main content

PivotGridFieldOptions.AllowFilterBySummary Property

Gets or sets whether end-users are allowed to filter pivot grid data by summaries calculated against the current data field.

Namespace: DevExpress.XtraPivotGrid

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

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Dashboard.Design

Declaration

[DefaultValue(DefaultBoolean.Default)]
public DefaultBoolean AllowFilterBySummary { get; set; }

Property Value

Type Default Description
DefaultBoolean Default

A DefaultBoolean enumeration member that specifies whether end-users are allowed to filter pivot grid data by summaries calculated against the current data field.

Available values:

Name Description Return Value
True

The value is true.

0

False

The value is false.

1

Default

The value is specified by a global option or a higher-level object.

2

Property Paths

You can access this nested property as listed below:

Library Object Type Path to AllowFilterBySummary
Cross-Platform Class Library PivotGridFieldBase
.Options.AllowFilterBySummary
WinForms Controls PivotGridField
.Options.AllowFilterBySummary
Reporting XRPivotGridField
.Options.AllowFilterBySummary
ASP.NET MVC Extensions MVCxPivotGridField
.Options.AllowFilterBySummary
ASP.NET Web Forms Controls PivotGridField
.Options.AllowFilterBySummary

Remarks

If the AllowFilterBySummary property is set to DefaultBoolean.False, a filter button is not displayed in the header of the current field when it is located in the Data Header Area.

When the AllowFilterBySummary property is set to DefaultBoolean.Default, the pivot grid’s PivotGridOptionsCustomization.AllowFilterBySummary property is in effect.

For more information, see Filtering by Summaries.

To specify whether end-users are allowed to filter data by this field when it is not located in the Data Header Area, use the PivotGridFieldOptions.AllowFilter property.

See Also