PivotGridControl.FilterEditorTemplate Property

Gets or sets a template that defines the presentation of the Filter Element within the Filter Editor dialog. This is a dependency property.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v19.2.dll

Declaration

C#

public DataTemplate FilterEditorTemplate { get; set; }

VB.NET

Public Property FilterEditorTemplate As DataTemplate

Property Value

Type	Description
DataTemplate	A DataTemplate object.

Example

Note

The complete sample project How to Customize a Filter Editor is available in the DevExpress Examples repository.

Use the PivotGridControl.FilterEditorTemplate property to specify a custom data template. You can also use the PivotGridControl.FilterEditorDialogServiceTemplate property to modify the appearance and functionality of the window that hosts the FilterEditorControl. To customize the list of operators, handle the FilterEditorControl.QueryOperators event. The following code demonstrates how to remove all operators except Between and NotBetween:

Xaml

<dxpg:PivotGridControl.FilterEditorTemplate>
    <DataTemplate>
        <dxfui:FilterEditorControl QueryOperators="FilterEditorControl_QueryOperators" />
    </DataTemplate>
</dxpg:PivotGridControl.FilterEditorTemplate>

C#

using DevExpress.Xpf.Core.FilteringUI;
// ... 
private void FilterEditorControl_QueryOperators(object sender, FilterEditorQueryOperatorsEventArgs e)
{
    if (e.FieldName == "fieldOrderDate")
    {
        e.Operators.Clear();
        e.Operators.Add(new FilterEditorOperatorItem(FilterEditorOperatorType.Between) { Caption = "Between" });
        e.Operators.Add(new FilterEditorOperatorItem(FilterEditorOperatorType.NotBetween) { Caption = "NotBetween" });
    }
}

VB.NET

Imports DevExpress.Xpf.Core.FilteringUI
' ...
Private Sub FilterEditorControl_QueryOperators(ByVal sender As Object, ByVal e As FilterEditorQueryOperatorsEventArgs)
    If e.FieldName = "fieldOrderDate" Then
        e.Operators.Clear()
        e.Operators.Add(New FilterEditorOperatorItem(FilterEditorOperatorType.Between) With {.Caption = "Between"})
        e.Operators.Add(New FilterEditorOperatorItem(FilterEditorOperatorType.NotBetween) With {.Caption = "NotBetween"})
        e.Operators.Add(CreateLastYearsOperator())
    End If
End Sub 

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FilterEditorTemplate property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-pivotgrid-customize-filter-editor/CS/WpfPivotCustomizeFilterEditorExample/WpfPivotCustomizeFilterEditorExample/MainWindow.xaml#L45

UseLegacyFilterEditor="False">
<dxpg:PivotGridControl.FilterEditorTemplate>
    <DataTemplate>