【WPF】从普通 ItemsControl 到支持筛选的 ItemsControl:深入掌握 CollectionViewSource 用法

✨ 从普通 ItemsControl 到支持筛选的 ItemsControl:深入掌握 CollectionViewSource 用法

在日常 WPF 开发中,我们经常需要对数据进行筛选、排序、分组等操作,而原生的 ItemsControl 并不直接支持这些功能。本文将介绍如何通过 CollectionViewSource 给一个普通的 ItemsControl 加上 动态筛选功能 ,并指出其中的一些关键注意点


📦 一、初始结构:普通 ItemsControl 显示列表

我们从一个最简单的 ItemsControl 开始:

xml 复制代码
<ItemsControl ItemsSource="{Binding MBConfigList}">
    <ItemsControl.ItemTemplate>
        <DataTemplate>
            <TextBlock Text="{Binding FileName}" />
        </DataTemplate>
    </ItemsControl.ItemTemplate>
</ItemsControl>

这个控件可以显示绑定的 MBConfigList 数据,但没有任何过滤能力。


🛠️ 二、目标:支持按光源类型筛选

我们希望最终能够让用户勾选光源类型,动态筛选出指定类型的数据。例如:

  • 支持"全选"
  • 多个 CheckBox 动态刷新列表
  • 用户操作后立即生效

🧰 三、改造步骤


1️⃣ 引入 CollectionViewSource

我们在 ViewModel 中定义一个 CollectionViewSource 并设置过滤事件:

csharp 复制代码
private CollectionViewSource _viewSource;

public ICollectionView FilteredMBConfigList
{
    get => _viewSource?.View;
    private set => SetProperty(ref _filteredView, value); // 实现 INotifyPropertyChanged
}

public void InitializeFilteredView()
{
    _viewSource = new CollectionViewSource
    {
        Source = GlobalData.Instance.saveInfo.MBConfigList
    };
    _viewSource.Filter += ApplyFilter;
    FilteredMBConfigList = _viewSource.View;
}

FilteredMBConfigList 必须是支持通知的不然界面是不会变化的。


2️⃣ 编写筛选逻辑 ApplyFilter

csharp 复制代码
private void ApplyFilter(object sender, FilterEventArgs e)
{
    if (e.Item is MBConfigInfo item)
    {
        var selectedTypes = LightSourceItems
            .Where(x => x.IsChecked)
            .Select(x => x.Name)
            .ToHashSet();//ToHashSet()是为了更快的查询

        // 显示所有或匹配项
        e.Accepted = selectedTypes.Count == 0 || selectedTypes.Contains(item.LightSourceType);
    }
}

private CollectionViewSource _viewSource; 不能申明成局部变量,不然ApplyFilter只能生效一次。

e.Accepted == true 的选项才会被显示出来。


3️⃣ UI 绑定到新集合

xml 复制代码
<ItemsControl ItemsSource="{Binding FilteredMBConfigList}">
    <ItemsControl.ItemTemplate>
        <DataTemplate>
            <TextBlock Text="{Binding FileName}" />
        </DataTemplate>
    </ItemsControl.ItemTemplate>
</ItemsControl>

这样,控件就用上了支持筛选的视图。


🚨 四、关键注意事项


⚠️ 1. CollectionViewSource 必须缓存

不能每次 get 都创建新的 CollectionViewSource,否则不会触发 .Refresh()

csharp 复制代码
// 错误写法(每次都 new):
public ICollectionView Filtered => new CollectionViewSource { Source = xxx }.View;

// 正确:只创建一次

⚠️ 2. 调用 View.Refresh() 以应用筛选

数据变化时,你必须手动调用:

csharp 复制代码
FilteredMBConfigList.Refresh();

建议绑定项(如 CheckBox)中 PropertyChanged 事件或命令中执行刷新。

FilteredMBConfigList.Refresh();调用后会重新触发ApplyFilter 以到达筛选的目的。


⚠️ 3. 筛选逻辑不要复杂耗时

FilterEventArgs 的处理函数会在每次刷新时对 所有项 执行。避免长计算!


⚠️ 4. UI 绑定的是 View,不是 CollectionViewSource 本身

绑定语法是:

xml 复制代码
ItemsSource="{Binding FilteredMBConfigList}"

不是 _viewSource,而是其 .View


✅ 五、示例:支持多选筛选项结构

使用一个简单的模型:

csharp 复制代码
public class LightSourceFilterItem : INotifyPropertyChanged
{
    public string Name { get; }
    public bool IsChecked { get; set; } // 实现通知
}

ViewModel:

csharp 复制代码
public ObservableCollection<LightSourceFilterItem> LightSourceItems { get; set; }

LightSourceItems = new ObservableCollection<LightSourceFilterItem>(
    new[] { "上光源", "下光源", "侧光源" }.Select(name =>
    {
        var item = new LightSourceFilterItem(name) { IsChecked = true };
        item.PropertyChanged += (_, __) => FilteredMBConfigList?.Refresh();
        return item;
    }));

XAML:

xml 复制代码
<ItemsControl ItemsSource="{Binding LightSourceItems}">
    <ItemsControl.ItemTemplate>
        <DataTemplate>
            <CheckBox Content="{Binding Name}" IsChecked="{Binding IsChecked, Mode=TwoWay}" />
        </DataTemplate>
    </ItemsControl.ItemTemplate>
</ItemsControl>

🏁 六、总结

优点 ✅ 注意点 ⚠️
支持筛选、排序、分组 .Refresh() 要手动调用
ItemsControl, ListBox, DataGrid 搭配无缝 Filter 逻辑要快
不改变原始集合 不要频繁 new CollectionViewSource

使用 CollectionViewSource 是 WPF 中实现数据视图分离的经典方式,非常适合构建支持过滤的 UI。

相关推荐
甄天41 分钟前
WPF路由事件:冒泡、隧道与直接全解析
c#·wpf·visual studio
三千道应用题3 小时前
WPF学习笔记(12)下拉框控件ComboBox与数据模板
wpf
界面开发小八哥4 小时前
界面组件DevExpress WPF中文教程:Grid - 如何获取节点?
.net·wpf·界面控件·devexpress·ui开发
三千道应用题4 小时前
WPF学习笔记(22)项面板模板ltemsPanelTemplate与三种模板总结
wpf
佛·追命8 小时前
.net wpf混淆
.net·wpf
weixin_4471035810 小时前
Wpf布局之StackPanel!
wpf
小老鼠爱大米10 小时前
[C#] WPF - 资源URI
c#·wpf·uri
三千道应用题18 小时前
WPF学习笔记(13)列表框控件ListBox与数据模板
wpf
甄天10 天前
WPF中MVVM和MVVMLight模式
c#·wpf·visual studio
CoderIsArt12 天前
C# WPF常用调试工具汇总
开发语言·c#·wpf