GridFilterMenuButtonDisplayMode Enum

Lists values that specify when to display column filter menu buttons in the Grid.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.Grid.v26.1.dll

Declaration

public enum GridFilterMenuButtonDisplayMode

Members

Name	Description
Default	For the DxGrid.FilterMenuButtonDisplayMode property, the buttons are always hidden. For the DxGridDataColumn.FilterMenuButtonDisplayMode property, to inherit the value from the DxGrid.FilterMenuButtonDisplayMode property
Never	The buttons are always hidden.
Always	The buttons are always visible.
VisibleOnHover	The buttons are visible on hover.

Related API Members

The following properties accept/return GridFilterMenuButtonDisplayMode values:

Library	Related API Members
Blazor	DxGrid.FilterMenuButtonDisplayMode
	DxGridDataColumn.FilterMenuButtonDisplayMode
	IGrid.FilterMenuButtonDisplayMode
	IGridDataColumn.FilterMenuButtonDisplayMode
XAF: Cross-Platform .NET App UI & Web API	DxGridModel.FilterMenuButtonDisplayMode

Remarks

A filter menu button opens a drop-down menu containing all unique column values. Users can select and deselect these values to filter Grid data.

Run Demo: Column Filter Menu Read Tutorial: Column Filter Menu in Blazor Grid

Use DxGrid.FilterMenuButtonDisplayMode to specify filter menu button visibility for all data columns, and a column’s FilterMenuButtonDisplayMode property to specify button visibility for that column. The following values are available for both properties:

Always

Filter menu buttons are visible.

Never

Filter menu buttons are hidden.

VisibleOnHover

A column displays the filter menu button in the following cases:

• Users move the mouse pointer over the column header.
• Users focus the column header using keyboard shortcuts.
• A filter is applied to the column.
• The application runs on a touch device. In this case, the hover state is unavailable and filter menu buttons are always visible.

Note

The Grid cannot create filter item lists for columns associated with certain data types (for instance, arrays and images). If you do not implement a filter menu template for such a column, the column filter menu displays the following text instead of filter items: “No filters are available for this column.”

Example

The following code snippet configures filter menu buttons as follows:

• Product Name and Discontinued columns always display filter menu buttons.
• The Units in Order column displays a filter menu button on hover.
• The Unit Price column does not display a filter menu button.

Razor

@inject ProductService ProductData

<DxGrid Data="@products" FilterMenuButtonDisplayMode="GridFilterMenuButtonDisplayMode.Always">
    <Columns>
        <DxGridDataColumn FieldName="ProductName" />
        <DxGridDataColumn FieldName="UnitPrice" 
                          FilterMenuButtonDisplayMode="GridFilterMenuButtonDisplayMode.Never" />
        <DxGridDataColumn FieldName="UnitsInOrder" Caption="Units in Order"
                          FilterMenuButtonDisplayMode="GridFilterMenuButtonDisplayMode.VisibleOnHover"/>
        <DxGridDataColumn FieldName="Discontinued" />
    </Columns>
</DxGrid>

@code {
    private Product[]? products;
    protected override async Task OnInitializedAsync() {
        products = await ProductData.GetData();
    }
}

ProductService.cs

public class ProductService {
    public Task<Product[]> GetData() {
        List<Product> products = new List<Product>();
        products.Add(new Product() { ProductID = 1, ProductName = "Chai", UnitPrice = 19, UnitsInOrder = 20, Discontinued = true });
        products.Add(new Product() { ProductID = 2, ProductName = "Chang", UnitPrice = 19, UnitsInOrder = 40, Discontinued = true });
        products.Add(new Product() { ProductID = 3, ProductName = "Aniseed Syrup", UnitPrice = 10, UnitsInOrder = 70, Discontinued = true });
        products.Add(new Product() { ProductID = 4, ProductName = "Mishi Kobe Niku", UnitPrice = 97, UnitsInOrder = 32, Discontinued = false });
        products.Add(new Product() { ProductID = 5, ProductName = "Ikura", UnitPrice = 31, UnitsInOrder = 10 });
        products.Add(new Product() { ProductID = 6, ProductName = "Chef Anton's Cajun Seasoning", UnitPrice = 22, UnitsInOrder = 12, Discontinued = false });
        products.Add(new Product() { ProductID = 7, ProductName = "Chef Anton's Gumbo Mix", UnitPrice = 21.35m, UnitsInOrder = 16, Discontinued = true });
        products.Add(new Product() { ProductID = 8, ProductName = "Grandma's Boysenberry Spread", UnitPrice = 25, UnitsInOrder = 20, Discontinued = true });
        products.Add(new Product() { ProductID = 9, ProductName = "Uncle Bob's Organic Dried Pears", UnitPrice = 30, UnitsInOrder = 24, Discontinued = false });
        products.Add(new Product() { ProductID = 10, ProductName = "Northwoods Cranberry Sauce", UnitPrice = 40, UnitsInOrder = 18, Discontinued = false });
        products.Add(new Product() { ProductID = 11, ProductName = "Queso Cabrales", UnitPrice = 21, UnitsInOrder = 30 });
        products.Add(new Product() { ProductID = 12, ProductName = "Queso Manchego La Pastora", UnitPrice = 38, UnitsInOrder = 10 });
        return Task.FromResult(products.ToArray());
    }
}

Product.cs

public class Product {
    public int ProductID { get; set; }
    public string ProductName { get; set; }
    public decimal? UnitPrice { get; set; }
    public short? UnitsInOrder { get; set; }
    public bool? Discontinued { get; set; }
}

Program.cs

// ...
builder.Services.AddSingleton<ProductService>();