DxTreeListDataColumn.FilterMenuTemplate Property

Specifies a template used to display the column’s filter menu.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v25.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[Parameter]
public RenderFragment<TreeListDataColumnFilterMenuTemplateContext> FilterMenuTemplate { get; set; }

Property Value

Type	Description
RenderFragment<TreeListDataColumnFilterMenuTemplateContext>	The template content.

Remarks

Use the FilterMenuTemplate property to define a template for the column filter menu.

The template accepts a TreeListDataColumnFilterMenuTemplateContext object as the context parameter. This parameter allows you to do the following:

• Specify the filter criteria the filter menu applies to the data column (the FilterCriteria property).
• Obtain a list of default filter menu items (the GetDataItemsAsync() method).
• Choose the view type for DateTime and DateTime? values (ListView and HierarchicalDateView properties).

Note

The GetDataItemsAsync() method cannot obtain unique values from a column whose data items do not implement IComparable type. If you call the method for such a column, an error may occur.

To define a common column filter menu template for all TreeList columns, use the DxTreeList.DataColumnFilterMenuTemplate property.

Run Demo: Column Filter Menu

The following example displays the Start Date filter menu as a ListView:

<DxTreeList Data="Data"
            KeyFieldName="Id"
            ParentKeyFieldName="ParentId"
            FilterMenuButtonDisplayMode="TreeListFilterMenuButtonDisplayMode.Always"
            CustomizeFilterMenu="TreeList_CustomizeFilterMenu"
            CssClass="max-h-480">
    <Columns>
        <DxTreeListDataColumn FieldName="Name" Caption="Task" />
        <DxTreeListDataColumn FieldName="EmployeeName" Caption="Assigned To" TextAlignment="TreeListTextAlignment.Left" />
        <DxTreeListDataColumn FieldName="StartDate" Width="150px">
            <FilterMenuTemplate>
                @context.ListView
            </FilterMenuTemplate>
        </DxTreeListDataColumn>
        <DxTreeListDataColumn FieldName="DueDate" Width="150px" />
    </Columns>
</DxTreeList>

For more information about templates in the TreeList component, refer to the following topic: Templates in Blazor TreeList.

Implements

FilterMenuTemplate