VirtualizingStackPanel + MVVM + multiple selection

Question

I have implemented a selection pattern similar to the one described in this post using a ViewModel to store the IsSelected value, and by binding the ListViewItem.IsSelected to the ViewModel IsSelected:

<ListView.ItemContainerStyle>
    <Style TargetType="{x:Type ListViewItem}">
        <Setter Property="IsSelected" Value="{Binding Mode=TwoWay, Path=IsSelected}"/>
    </Style>
</ListView.ItemContainerStyle>

It works in general, but I encounter a severe problem. By using the a VirtualizingStackPanel as the panel in the list view, only the visible ListViewItem are getting created. If I use "Ctrl+A" to select all items, or by using shortcut combination such "Shift+Ctrl+End" on the first item, all items get selected, but for the non visible items, the ViewModel does not get its IsSelected set to true. That is logical, because if the ListViewItem are not created, the binding can't work.

Anybody experienced the same issue, and found a solution (apart from not using a VirtualizingStackPanel)?

Try this complete solution for this issue: http://stackoverflow.com/a/29545790 — qwerty176, Apr 09 '15 at 18:17

score 32 · Accepted Answer · answered Aug 13 '09 at 19:43

32

I found another way of handling selection in the MVVM pattern, which solved my issue. Instead of maintaining the selection in the viewmodel, the selection is retrieved from the ListView/ListBox, and passed as a parameter to the Command. All done in XAML:

<ListView 
    x:Name="_items"
    ItemsSource="{Binding Items}" ... />

<Button 
    Content="Remove Selected" 
    Command="{Binding RemoveSelectedItemsCommand}" 
    CommandParameter="{Binding ElementName=_items, Path=SelectedItems}"/>

in my ViewModel:

private void RemoveSelection(object parameter)
{
    IList selection = (IList)parameter;
    ...
}

answered Aug 13 '09 at 19:43

decasteljau

7,655
10
41
58

7

I like this approach, but you cannot select items programmatically from the viewmodel this way. – sourcenouveau Jan 13 '11 at 15:07
2

It will aslo won't work if Listview and the button are in different user control scope. – Rakshit Bakshi Sep 15 '14 at 23:37

score 8 · Answer 2 · answered Nov 12 '09 at 15:50

In my case, I ended up solving this by deriving a ListBoxEx class from ListBox, and adding code to respond to selection changes, enforcing the selection state on the item view models:

private readonly List<IListItemViewModelBase> selectedItems = new List<IListItemViewModelBase>();

protected override void OnSelectionChanged(SelectionChangedEventArgs e)
{
    base.OnSelectionChanged(e);

    bool isVirtualizing = VirtualizingStackPanel.GetIsVirtualizing(this);
    bool isMultiSelect = (SelectionMode != SelectionMode.Single);

    if (isVirtualizing && isMultiSelect)
    {
        var newSelectedItems = SelectedItems.Cast<IListItemViewModelBase>();

        foreach (var deselectedItem in this.selectedItems.Except(newSelectedItems))
        {
            deselectedItem.IsSelected = false;
        }

        this.selectedItems.Clear();
        this.selectedItems.AddRange(newSelectedItems);

        foreach (var newlySelectedItem in this.selectedItems)
        {
            newlySelectedItem.IsSelected = true;
        }
    }
}

Perfect. Solves the root problem by keeping the viewmodel in sync! — RandomEngy, Mar 25 '19 at 04:14
Finally, a fix to virtualisation/MVVM/IsSelected issues that have bugged me for years! — Andrew Stephens, Apr 08 '22 at 10:34

score 1 · Answer 3 · answered Aug 13 '09 at 19:08

1

Apart from not using VirtualizingStackPanel, the only thing I can think of is to capture those keyboard shortcuts and have methods for modifying a certain range of your ViewModel items so that their IsSelected property is set to True (e.g., SelectAll(), SelectFromCurrentToEnd()). Basically bypassing the Binding on ListViewItem for controlling the selection for such cases.

answered Aug 13 '09 at 19:08

Joel B Fant

24,406
4
66
67

3

Don't forget all the different ways this can happen with the keyboard or mouse! Ctrl+A, Shift+End, Shift+Home, and you can Shift-Click an arbitrary range with the mouse; all these things can cause the same problem. – Qwertie Nov 10 '11 at 23:11

VirtualizingStackPanel + MVVM + multiple selection

3 Answers3

Linked

Related