GridViewDataColumnSettings.AllowAutoFilter Property

Gets or sets whether end-users can filter data by the column’s values.

Assembly : DevExpress.Web.v25.2.dll

Declaration

C#
VB.NET

csharp

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

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

Property Value

Type	Default	Description
DefaultBoolean	Default

One of the enumeration values.

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 AllowAutoFilter
GridViewDataColumn

.Settings .AllowAutoFilter

Remarks

End-users can filter data on the fly by typing text directly into the auto filter row. When an end-user types the text within the row a filter condition is automatically created based upon the values entered and applied to the column.

The filter row is displayed if the ASPxGridViewSettings.ShowFilterRow option is enabled. Set the AllowAutoFilter property to false to prevent data to be filtered by the column’s values. In this instance, the filter row doesn’t display a cell that corresponds to the column.

To learn more, see Filtering.

Example

The following example illustrates how to use the AllowAutoFilter property.

Web Forms approach:

Note

For a full example, see the ASPxGridView - Customization Dialog demo.

ASPX

aspx

<dx:ASPxGridView ID="Grid" runat="server" DataSourceID="ProductsDataSource" 
    EnableRowsCache="false" Width="100%">
    <Columns>
        <dx:GridViewDataTextColumn FieldName="ProductName">
            <Settings AutoFilterCondition="Contains" />
        </dx:GridViewDataTextColumn>
        <dx:GridViewDataComboBoxColumn FieldName="CategoryID" Caption="Category Name" SortIndex="0" SortOrder="Ascending" AdaptivePriority="1">
            <PropertiesComboBox DataSourceID="CategoriesDataSource" ValueField="CategoryID" TextField="CategoryName" ValueType="System.Int32" />
            <Settings AllowHeaderFilter="True" AllowAutoFilter="False" SortMode="DisplayText" />
            <SettingsHeaderFilter Mode="CheckedList" />
        </dx:GridViewDataComboBoxColumn>
        ...
    </Columns>
</dx:ASPxGridView>

MVC approach:

Note

For a full example, see the GridView - Customization Dialog demo.

Razor

cshtml

@Html.DevExpress().GridView(settings => {
    settings.Name = "GridView";
    settings.SettingsCustomizationDialog.Enabled = true;
    ...
    settings.Columns.Add(c => {
        c.FieldName = "ProductName";
        c.Settings.AutoFilterCondition = AutoFilterCondition.Contains;
    });
    settings.Columns.Add(c => {
        c.FieldName = "CategoryID";
        c.Caption = "Category Name";
        c.SortIndex = 0;
        c.SortOrder = DevExpress.Data.ColumnSortOrder.Ascending;
        c.AdaptivePriority = 1;
        c.Settings.AllowHeaderFilter = DefaultBoolean.True;
        c.Settings.AllowAutoFilter = DefaultBoolean.False;
        c.Settings.SortMode = DevExpress.XtraGrid.ColumnSortMode.DisplayText;
        c.SettingsHeaderFilter.Mode = GridHeaderFilterMode.CheckedList;
        c.EditorProperties().ComboBox(cb => {
            cb.DataSource = NorthwindDataProvider.GetCategories();
            cb.TextField = "CategoryName";
            cb.ValueField = "CategoryID";
            cb.ValueType = typeof(int);
        });
    });
}).Bind(Model).GetHtml()