PivotGridOptionsCustomization.AllowPrefilter Property

Gets or sets whether end-users are allowed to invoke the Prefilter.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Boolean	**true**	true to allow end-users to invoke the Prefilter; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to AllowPrefilter
WinForms Controls	PivotGridControl	.OptionsCustomization.AllowPrefilter
ASP.NET Controls and MVC Extensions	ASPxPivotGrid	.OptionsCustomization.AllowPrefilter
	MVCxPivotGrid	.OptionsCustomization.AllowPrefilter
	PivotGridSettings	.OptionsCustomization.AllowPrefilter
Reporting	XRPivotGrid	.OptionsCustomization.AllowPrefilter

Remarks

If the AllowPrefilter property is set to true, an end-user can invoke a Prefilter via a context menu:

The Prefilter allows an end-user to apply a filter to the underlying data source. The PivotGridControl will only display and process data that matches the criteria imposed by the Prefilter.

If the AllowPrefilter property is set to false, the “Show Prefilter” menu command is not available.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowPrefilter 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-use-an-external-filtercontrol-to-filter-a-pivotgridcontrol-e2170/CS/WinFormsExample/MyPivotGridControl.cs#L8

public MyPivotGridControl() {
    this.OptionsCustomization.AllowPrefilter = false;
}

VB.NET

how-to-use-an-external-filtercontrol-to-filter-a-pivotgridcontrol-e2170/VB/WinFormsExample/MyPivotGridControl.vb#L11

Public Sub New()
    Me.OptionsCustomization.AllowPrefilter = False
End Sub