PivotGridFieldOptions.AllowFilter Property

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

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

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

VB.NET

<DefaultValue(DefaultBoolean.Default)>
<XtraSerializableProperty>
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
True	Corresponds to a Boolean value of true.
False	Corresponds to a Boolean value of false.
Default	The value is determined by the current object’s parent object setting (e.g., a control setting).

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to AllowFilter
Cross-Platform Class Library	PivotGridFieldBase	.Options.AllowFilter
WinForms Controls	PivotGridField	.Options.AllowFilter
Reporting	XRPivotGridField	.Options.AllowFilter
ASP.NET Web Forms Controls	PivotGridField	.Options.AllowFilter
	MVCxPivotGridField	.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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowFilter 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.

C#

how-to-replace-the-default-filter-popup-with-a-custom-one-made-with-aspxgridview-control-e4669/CS/CustomFilterPopup/FilterPopup.ascx.cs#L165

PivotGridHeaderHtmlTable fieldHeaderTable = c.CreateHeader();
if ( c.Field.Visible  && c.Field.Area != DevExpress.XtraPivotGrid.PivotArea.DataArea && c.Field.Options.AllowFilter != DevExpress.Utils.DefaultBoolean.False)
{

VB.NET

how-to-replace-the-default-filter-popup-with-a-custom-one-made-with-aspxgridview-control-e4669/VB/CustomFilterPopup/FilterPopup.ascx.vb#L161

Dim fieldHeaderTable As PivotGridHeaderHtmlTable = c.CreateHeader()
If c.Field.Visible AndAlso c.Field.Area <> DevExpress.XtraPivotGrid.PivotArea.DataArea AndAlso c.Field.Options.AllowFilter <> DevExpress.Utils.DefaultBoolean.False Then