TreeList.FilterPopupExcelQueryFilterCriteria Event

Fires when a new data filter is about to be applied to the control using the Excel-style Filter Dropdown, and allows you to substitute the filter.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v18.2.dll

Declaration

C#

[DXCategory("Behavior")]
public event FilterPopupExcelQueryFilterCriteriaEventHandler FilterPopupExcelQueryFilterCriteria

VB.NET

<DXCategory("Behavior")>
Public Event FilterPopupExcelQueryFilterCriteria As FilterPopupExcelQueryFilterCriteriaEventHandler

Event Data

The FilterPopupExcelQueryFilterCriteria event's data class is DevExpress.XtraTreeList.FilterPopupExcelQueryFilterCriteriaEventArgs.

Remarks

In the example below, a sample application displays video data. The “Tag” field stores video tags separated by commas as a single string. The TreeList.FilterPopupExcelData event splits these strings into individual tags available for end-users from the “Values” tab of Excel-styled filters. The FilterPopupExcelQueryFilterCriteria event is handled to replace the default “Equals” condition with “Contains”.

C#

using DevExpress.Data.Filtering;
using DevExpress.Utils.Filtering.Internal;

//create items that represent individual tags
private void treeList1_FilterPopupExcelData(object sender, DevExpress.XtraTreeList.FilterPopupExcelDataEventArgs e)
{
    if (e.Column.FieldName == "Tag")
    {
        var tags = e.DataItems.SelectMany(x => x.Text.Split(',', ';'))
            .OrderBy(x => x)
            .Distinct()
            .ToArray();
        e.DataItems.Clear();
        for (int i = 0; i < tags.Length; i++)
            e.AddData(tags[i], tags[i]);
    }

}
//modify filter criteria expressions
private void treeList1_FilterPopupExcelQueryFilterCriteria(object sender, DevExpress.XtraTreeList.FilterPopupExcelQueryFilterCriteriaEventArgs e)
{
    if (e.Column.FieldName == "Tag")
    {
        var viewModel = e.Value as ICollectionValueViewModel<string>;
        DevExpress.Data.Filtering.OperandProperty property = new DevExpress.Data.Filtering.OperandProperty(e.Path);
        e.FilterCriteria = GroupOperator.Or(viewModel.Values.Select(x =>
                   new FunctionOperator(FunctionOperatorType.Contains, property, x)));
    }

}

VB.NET

Imports DevExpress.Data.Filtering
Imports DevExpress.Utils.Filtering.Internal

'create items that represent individual tags
Private Sub treeList1_FilterPopupExcelData(sender As Object, e As DevExpress.XtraTreeList.FilterPopupExcelDataEventArgs)
    If e.Column.FieldName = "Tag" Then
        Dim tags = e.DataItems.SelectMany(Function(x) x.Text.Split(","c, ";"c)).OrderBy(Function(x) x).Distinct().ToArray()
        e.DataItems.Clear()
        For i As Integer = 0 To tags.Length - 1
            e.AddData(tags(i), tags(i))
        Next
    End If

End Sub
'modify filter criteria expressions
Private Sub treeList1_FilterPopupExcelQueryFilterCriteria(sender As Object, e As DevExpress.XtraTreeList.FilterPopupExcelQueryFilterCriteriaEventArgs)
    If e.Column.FieldName = "Tag" Then
        Dim viewModel = TryCast(e.Value, ICollectionValueViewModel(Of String))
        Dim [property] As New OperandProperty(e.Path)
        e.FilterCriteria = GroupOperator.[Or](viewModel.Values.[Select](Function(x) New FunctionOperator(FunctionOperatorType.Contains, [property], x)))
    End If

End Sub