PivotGridFieldOptions.AllowFilter Property

Gets or sets whether an end-user can apply a filter to the current field.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
DefaultBoolean	Default	A DefaultBoolean enumeration value specifying whether end-users can apply a filter to the current 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:

Object Type	Path to AllowFilter
PivotGridFieldBase	.Options .AllowFilter

Remarks

This property is in effect for fields displayed within Column Header Area, Row Header Area and Filter Header Area. An end-user can apply a filter to these fields via Filter Buttons.

If the AllowFilter property is set to DefaultBoolean.Default the ability to filter data is determined by the control’s PivotGridOptionsCustomization.AllowFilter property.

Set the AllowFilter property to DefaultBoolean.False to prevent an end-user from modifying the current filter criteria specified by the PivotGridFieldBase.FilterValues property.

If the AllowFilter property is set to DefaultBoolean.True, an end-user can filter data regardless of the PivotGridOptionsCustomization.AllowFilter property value.

To specify whether end-users are allowed to apply filtering by summaries, use the PivotGridFieldOptions.AllowFilterBySummary property.