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.v21.2.Core.dll

NuGet Package: DevExpress.PivotGrid.Core

Declaration

C#

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

VB.NET

<DefaultValue(DefaultBoolean.Default)>
Public Property AllowFilterBySummary As DefaultBoolean

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
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowFilterBySummary
PivotGridFieldBase	.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.