DevExpress Winforms使用技巧教程：掌握Filter Editor（二）-控件新闻-慧都网

DevExpress Winforms使用技巧教程：掌握Filter Editor（二）

原创|使用教程|编辑：龚雪|2020-03-24 10:02:04.130|阅读 531 次

概述：DevExpress WinForms安装附带两个允许最终用户构建过滤器查询的控件：提供GUI的Filter控件和将Filter控件与基于文本输入的面板组合在一起的Filter Editor控件。

Registering函数

自定义函数准备就绪后，您需要对其进行注册，即将其添加到Filter控件和Filter Editor控件支持的函数列表中。如果您在自定义函数类中包括了可选的Register和Unregister方法，则注册代码很短：

//Program.cs file
namespace DXSample {
static class Program {
[STAThread]
static void Main() {
IsWeekendFunction.Register();
WithinDaysOfTodayFunction.Register();
NotBeginsWithFunction.Register();

// ...
Application.Run(new Main());
}
}
}

从技术上讲，您的函数现在可用。如果您在Filter Editor控件的文本面板中手动编辑表达式，并使用这些自定义函数中的任何一个，则将生成有效的过滤条件。但是到目前为止，这些函数将不会包含在可视化面板中。

根据您的要求，使用以下三种技术之一将自定义函数添加到GUI。

一种特定的控件

若要使一个函数仅可用于一个特定的数据感知控件及其嵌入式Filter Editor控件，请为该控件的QueryCustomFunctions事件实现一个处理程序。使用以下代码，可以在嵌入式Filter Editor和Excel-style过滤器菜单中为数据网格使用IsWeekendFunction，而仅在过滤器编辑器中可见“ InsideDaysOfToday”函数。

gridView1.QueryCustomFunctions += OnQueryCustomFunctions;

private void OnQueryCustomFunctions(object sender,
DevExpress.XtraGrid.Views.Grid.CustomFunctionEventArgs e) {
if(e.PropertyType == typeof(DateTime)) {
e.Add(IsWeekendFunction.FunctionName);
if(e.IsFilterEditor)
e.Add(WithinDaysOfTodayFunction.FunctionName);
}
}

所有Filter和Filter Editor控件

若要注册全局自定义函数来包含在所有Filter和Filter Editor控件中，请将它们添加到事件CriteriaOperator.QueryCustomFunctions的处理程序中。此示例中全局注册了NotBeginsWith函数：

static class Program {
[STAThread]
static void Main() {
// ...
CriteriaOperator.QueryCustomFunctions += OnQueryCustomUIFunctions;
// ...
}

private static void OnQueryCustomUIFunctions(object sender,
DevExpress.Data.Filtering.CustomFunctionEventArgs e) {
if(e.PropertyType == typeof(string)) {
e.Add(NotBeginsWithFunction.FunctionName);
}
}
}

特定于个别属性

若要注册所有Filter和Filter Editor控件都应该可用但特定于数据类型属性的函数，请使用属性DevExpress.Data.Filtering.CustomFunction注释属性。在此示例中，数据网格显示具有两个字符串属性Text和Info的类型，自定义函数NotBeginsWith仅适用于Info字段。

[CustomFunction(NotBeginsWithFunction.FunctionName /*, Image = <image>*/)]
public string Info {
get { return info; }
set {
if (info != value) {
info = value;
OnPropertyChanged();
}
}
}