OptionsColumnFilter.AllowFilter Property

Gets or sets whether the filter button in Grid Views (field filter button in Layout Views) is displayed within the column header.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

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

VB.NET

<DefaultValue(True)>
<XtraSerializableProperty>
Public Overridable Property AllowFilter As Boolean

Property Value

Type	Default	Description
Boolean	true	true if the column’s filter button is enabled; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowFilter
GridColumn	.OptionsFilter .AllowFilter

Remarks

Note that this property is not in effect when the View’s OptionsCustomization.AllowFilter option is disabled.

When columns are generated automatically based on business objects, you can use the Display attribute’s AutoGenerateFilter property to disable the filter UI. See Data Annotation Attributes for more information.

C#

[Display(AutoGenerateFilter = false)]
public string Email { get; set; }

VB.NET

<Display(AutoGenerateFilter:= False)>
Public Property Email() As String

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

winforms-grid-display-editors-in-columns-headers/CS/WindowsApplication1/Form1.cs#L35

gridColumn1.OptionsColumn.AllowSort = DevExpress.Utils.DefaultBoolean.False;
gridColumn1.OptionsFilter.AllowFilter = false;
new ColumnInplaceEditorHelper(gridColumn2, new RepositoryItemSpinEdit());

XAF-how-to-add-an-unbound-column-to-gridlisteditor-to-execute-a-custom-action-for-a-record/CS/WinSolution.Module.Win/SimpleBusinessActionGridListViewController.cs#L69

buttonColumn.OptionsColumn.ShowInCustomizationForm = false;
buttonColumn.OptionsFilter.AllowFilter = false;
InitButtonEditor(ref activeRepositoryItemButtonEdit, true);

VB.NET

winforms-grid-display-editors-in-columns-headers/VB/Form1.vb#L34

gridColumn1.OptionsColumn.AllowSort = DevExpress.Utils.DefaultBoolean.False
gridColumn1.OptionsFilter.AllowFilter = False
helper = New ColumnInplaceEditorHelper(gridColumn2, New RepositoryItemSpinEdit())

XAF-how-to-add-an-unbound-column-to-gridlisteditor-to-execute-a-custom-action-for-a-record/VB/WinSolution.Module.Win/SimpleBusinessActionGridListViewController.vb#L84

buttonColumn.OptionsColumn.ShowInCustomizationForm = False
buttonColumn.OptionsFilter.AllowFilter = False
InitButtonEditor(activeRepositoryItemButtonEdit, True)