PivotGridOptionsCustomization.AllowFilterBySummary Property

Gets or sets whether end-users are allowed to filter pivot grid data by summaries.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v19.1.Core.dll

Declaration

C#

[DefaultValue(true)]
[XtraSerializableProperty]
public bool AllowFilterBySummary { get; set; }

VB.NET

<DefaultValue(True)>
<XtraSerializableProperty>
Public Property AllowFilterBySummary As Boolean

Property Value

Type	Default	Description
Boolean	**true**	A DefaultBoolean enumeration member that specifies whether end-users are allowed to filter pivot grid data by summaries.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to AllowFilterBySummary
WinForms Controls	PivotGridControl	.OptionsCustomization.AllowFilterBySummary
Reporting	XRPivotGrid	.OptionsCustomization.AllowFilterBySummary
ASP.NET Web Forms Controls	ASPxPivotGrid	.OptionsCustomization.AllowFilterBySummary
	MVCxPivotGrid	.OptionsCustomization.AllowFilterBySummary
	PivotGridSettings	.OptionsCustomization.AllowFilterBySummary

Remarks

If the AllowFilterBySummary property is set to DefaultBoolean.False, filter buttons are not displayed in the headers of data fields.

The AllowFilterBySummary property is in effect for those fields whose PivotGridFieldOptions.AllowFilterBySummary property is set to DefaultBoolean.Default.

To learn more about filtering by summaries, see Filtering by Summaries Overview.

To specify whether end-users are allowed to filter data by column, row and filter fields, use the PivotGridOptionsCustomization.AllowFilter property.