GridOptionsCustomization.AllowFilter Property

Gets or sets a value which specifies whether end-users can filter data using the filter dropdowns.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[DefaultValue(true)]
[XtraSerializableProperty]
public virtual bool AllowFilter { get; set; }
<DefaultValue(True)>
<XtraSerializableProperty>
Public Overridable Property AllowFilter As Boolean

Property Value

Type Default Description
Boolean

true

true if end-users can filter data using the filter dropdowns; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type Path to AllowFilter
AdvBandedGridView
.OptionsCustomization.AllowFilter
AdvBandedGridView
.OptionsCustomization.AllowFilter
BandedGridView
.OptionsCustomization.AllowFilter
BandedGridView
.OptionsCustomization.AllowFilter
GridView
.OptionsCustomization.AllowFilter

Remarks

End-users can filter a View's data using filter dropdowns which can be invoked by clicking on the Filter Button displayed within column headers. By default, all columns display such buttons thus enabling end-users to apply data filtering. If the AllowFilter property's value is true the visibility of these buttons for each individual column can be specified. The desired columns' OptionsColumnFilter.AllowFilter option should be used for this purpose. If the AllowFilter property's value is false, none of the column headers will display filter buttons. The OptionsColumnFilter.AllowFilter option's value is ignored in this case.

End-users can also filter data using the auto filter row regardless of the AllowFilter property's value. The visibility of the auto filter row is specified by the GridOptionsView.ShowAutoFilterRow property.

For more information on data filtering, see the Filtering Overview topic.

See Also