Trigger Filter on CollectionViewSource Trigger Filter on CollectionViewSource wpf wpf

Trigger Filter on CollectionViewSource


Don't create a CollectionViewSource in your view. Instead, create a property of type ICollectionView in your view model and bind ListView.ItemsSource to it.

Once you've done this, you can put logic in the FilterText property's setter that calls Refresh() on the ICollectionView whenever the user changes it.

You'll find that this also simplifies the problem of sorting: you can build the sorting logic into the view model and then expose commands that the view can use.

EDIT

Here's a pretty straightforward demo of dynamic sorting and filtering of a collection view using MVVM. This demo doesn't implement FilterText, but once you understand how it all works, you shouldn't have any difficulty implementing a FilterText property and a predicate that uses that property instead of the hard-coded filter that it's using now.

(Note also that the view model classes here don't implement property-change notification. That's just to keep the code simple: as nothing in this demo actually changes property values, it doesn't need property-change notification.)

First a class for your items:

public class ItemViewModel{    public string Name { get; set; }    public int Age { get; set; }}

Now, a view model for the application. There are three things going on here: first, it creates and populates its own ICollectionView; second, it exposes an ApplicationCommand (see below) that the view will use to execute sorting and filtering commands, and finally, it implements an Execute method that sorts or filters the view:

public class ApplicationViewModel{    public ApplicationViewModel()    {        Items.Add(new ItemViewModel { Name = "John", Age = 18} );        Items.Add(new ItemViewModel { Name = "Mary", Age = 30} );        Items.Add(new ItemViewModel { Name = "Richard", Age = 28 } );        Items.Add(new ItemViewModel { Name = "Elizabeth", Age = 45 });        Items.Add(new ItemViewModel { Name = "Patrick", Age = 6 });        Items.Add(new ItemViewModel { Name = "Philip", Age = 11 });        ItemsView = CollectionViewSource.GetDefaultView(Items);    }    public ApplicationCommand ApplicationCommand    {        get { return new ApplicationCommand(this); }    }    private ObservableCollection<ItemViewModel> Items =                                      new ObservableCollection<ItemViewModel>();    public ICollectionView ItemsView { get; set; }    public void ExecuteCommand(string command)    {        ListCollectionView list = (ListCollectionView) ItemsView;        switch (command)        {            case "SortByName":                list.CustomSort = new ItemSorter("Name") ;                return;            case "SortByAge":                list.CustomSort = new ItemSorter("Age");                return;            case "ApplyFilter":                list.Filter = new Predicate<object>(x =>                                                   ((ItemViewModel)x).Age > 21);                return;            case "RemoveFilter":                list.Filter = null;                return;            default:                return;        }    }}

Sorting kind of sucks; you need to implement an IComparer:

public class ItemSorter : IComparer{    private string PropertyName { get; set; }    public ItemSorter(string propertyName)    {        PropertyName = propertyName;        }    public int Compare(object x, object y)    {        ItemViewModel ix = (ItemViewModel) x;        ItemViewModel iy = (ItemViewModel) y;        switch(PropertyName)        {            case "Name":                return string.Compare(ix.Name, iy.Name);            case "Age":                if (ix.Age > iy.Age) return 1;                if (iy.Age > ix.Age) return -1;                return 0;            default:                throw new InvalidOperationException("Cannot sort by " +                                                      PropertyName);        }    }}

To trigger the Execute method in the view model, this uses an ApplicationCommand class, which is a simple implementation of ICommand that routes the CommandParameter on buttons in the view to the view model's Execute method. I implemented it this way because I didn't want to create a bunch of RelayCommand properties in the application view model, and I wanted to keep all the sorting/filtering in one method so that it was easy to see how it's done.

public class ApplicationCommand : ICommand{    private ApplicationViewModel _ApplicationViewModel;    public ApplicationCommand(ApplicationViewModel avm)    {        _ApplicationViewModel = avm;    }    public void Execute(object parameter)    {        _ApplicationViewModel.ExecuteCommand(parameter.ToString());    }    public bool CanExecute(object parameter)    {        return true;    }    public event EventHandler CanExecuteChanged;}

Finally, here's the MainWindow for the application:

<Window x:Class="CollectionViewDemo.MainWindow"        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"        xmlns:CollectionViewDemo="clr-namespace:CollectionViewDemo"         Title="MainWindow" Height="350" Width="525">    <Window.DataContext>        <CollectionViewDemo:ApplicationViewModel />    </Window.DataContext>    <DockPanel>        <ListView ItemsSource="{Binding ItemsView}">            <ListView.View>                <GridView>                    <GridViewColumn DisplayMemberBinding="{Binding Name}"                                    Header="Name" />                    <GridViewColumn DisplayMemberBinding="{Binding Age}"                                     Header="Age"/>                </GridView>            </ListView.View>        </ListView>        <StackPanel DockPanel.Dock="Right">            <Button Command="{Binding ApplicationCommand}"                     CommandParameter="SortByName">Sort by name</Button>            <Button Command="{Binding ApplicationCommand}"                     CommandParameter="SortByAge">Sort by age</Button>            <Button Command="{Binding ApplicationCommand}"                    CommandParameter="ApplyFilter">Apply filter</Button>            <Button Command="{Binding ApplicationCommand}"                    CommandParameter="RemoveFilter">Remove filter</Button>        </StackPanel>    </DockPanel></Window>


Nowadays, you often don't need to explicitly trigger refreshes. CollectionViewSource implements ICollectionViewLiveShaping which updates automatically if IsLiveFilteringRequested is true, based upon the fields in its LiveFilteringProperties collection.

An example in XAML:

  <CollectionViewSource         Source="{Binding Items}"         Filter="FilterPredicateFunction"         IsLiveFilteringRequested="True">    <CollectionViewSource.LiveFilteringProperties>      <system:String>FilteredProperty1</system:String>      <system:String>FilteredProperty2</system:String>    </CollectionViewSource.LiveFilteringProperties>  </CollectionViewSource>


CollectionViewSource.View.Refresh();

CollectionViewSource.Filter is reevaluated in this way!