sorting - Sort and Group ListItems in a WPF ListBox- GroupItem collapse and expand

Question

I sort and group listbox items, I use CollectioView on this purpose.

From view model class I bind collection on ListBox ItemSource property, here is it.

    public BindableCollection<UserInfo> Friends
    {
        get { return _friends; }
        set
        {
            _friends = value;
            NotifyOfPropertyChange(() => Friends);
        }
    }

ListBox items is type of UserInfo.

When I initialize ListBox I sort and group items with this method.

    private ICollectionView _currentView;

    //...

    private void SortContactList()
    {
        _currentView = CollectionViewSource.GetDefaultView(Friends);

        _currentView.GroupDescriptions.Add(new PropertyGroupDescription("TextStatus"));

        _currentView.SortDescriptions.Add(new SortDescription("TextStatus", ListSortDirection.Ascending));

        _currentView.SortDescriptions.Add(new SortDescription("Nick", ListSortDirection.Ascending));
    }

TextStatus and Nick are properties of userInfo class.

I use in Listbox GroupStyle. Here ist it:

    <Style x:Key="MessengerView_ToogleBtn" TargetType="{x:Type ToggleButton}">
        <Setter Property="Template">
            <Setter.Value>
                <ControlTemplate TargetType="{x:Type ToggleButton}">
                    <Image x:Name="img" Source="/images/icons/Collapse.png" />
                    <ControlTemplate.Triggers>
                        <Trigger Property="IsChecked" Value="False">
                            <Setter TargetName="img" Property="Source" Value="/images/icons/Expand.png" />
                        </Trigger>
                    </ControlTemplate.Triggers>
                </ControlTemplate>
            </Setter.Value>
        </Setter>
    </Style>


   <GroupStyle>
                <GroupStyle.ContainerStyle>
                    <Style TargetType="{x:Type GroupItem}">
                        <Setter Property="Template">
                            <Setter.Value>
                                <ControlTemplate TargetType="{x:Type GroupItem}">
                                    <ControlTemplate.Triggers>
                                        <DataTrigger Binding="{Binding Path=IsBottomLevel}" Value="True">
                                            <Setter TargetName="gridTemplate" Property="Grid.Background" Value="White" />
                                        </DataTrigger>
                                    </ControlTemplate.Triggers>
                                    <Grid>
                                        <Grid.RowDefinitions>
                                            <RowDefinition />
                                            <RowDefinition />
                                        </Grid.RowDefinitions>
                                        <Grid Background="Black" 
                                                  x:Name="gridTemplate" 
                                                  Height="26" 
                                                  VerticalAlignment="Center">
                                            <Grid.ColumnDefinitions>
                                                <ColumnDefinition Width="Auto" />
                                                <ColumnDefinition Width="100" />
                                                <ColumnDefinition Width="45" />
                                            </Grid.ColumnDefinitions>

                                            <ToggleButton x:Name="btnShowHide" 
                                                          IsChecked="True" 
                                                          Style="{StaticResource MessengerView_ToogleBtn}"/>

                                            <TextBlock Style="{StaticResource MessengerView_LbGroupHeader_TextBlock}"  
                                                       Text="{Binding Path=Name}" 
                                                       Grid.Column="1"/>
                                            <TextBlock TextAlignment="Left" Style="{StaticResource MessengerView_LbGroupHeader_TextBlock}" 
                                                       Grid.Column="2" 
                                                       Text="{Binding Path=ItemCount}"/>

                                        </Grid>

                                        <ItemsPresenter Visibility="{Binding ElementName=btnShowHide, Path=IsChecked,
                                                                            Converter={StaticResource booleanToVisibilityConverter}}"
                                                            Margin="3,3,3,3"
                                                            Grid.Row="1"  />

                                    </Grid>
                                </ControlTemplate>
                            </Setter.Value>
                        </Setter>
                    </Style>
                </GroupStyle.ContainerStyle>
            </GroupStyle>

If I run app, it look on this picture.

1.

I edit source property of ListBox, (add,remove, update), after edited listbox I call Refresh method on CollectionView.

            _currentView.Refresh();

Problem is that GroupItem is collapse and I call Refresh method on all GroupItem are expanded.

For example.

GroupItem 1 is collapse.

GroupItem 2 is exapnded.

GroupItem 3 is collapse.

Before call Refresh ListBox look like on this picture:

I call Refresh method on CollectionView and all GroupItems are expanded. I would like to keep the original state, how can I achive this?

After called Refresh Lisbox look like on first picture on the top.

Answer 1

The workaround isn't perfect. As I said, it is better to use ViewModels with your own grouping, but it will require much more code.

You need two event handlers:

    private Dictionary<string, bool?> expandStates = new Dictionary<string, bool?>();

    private void Grid_Loaded(object sender, RoutedEventArgs e)
    {
        var grid = (Grid)sender;
        var dc = grid.DataContext as CollectionViewGroup;
        var groupName = (string)dc.Name;

        //If the dictionary contains the current group, retrieve a saved state of the group
        if (this.expandStates.ContainsKey(groupName))
        {
            var btn = (ToggleButton)grid.FindName("btnShowHide");
            btn.IsChecked = this.expandStates[groupName];
        } //Else add default state
        else this.expandStates.Add(groupName, true);

    }

    private void btnShowHide_Click(object sender, RoutedEventArgs e)
    {
        var btn = (ToggleButton)sender;
        var dc = (CollectionViewGroup)btn.DataContext;
        var groupName = (string)dc.Name;

        //Loaded event is fired earlier than the Click event, so I'm sure that the dictionary contains the key
        this.expandStates[groupName] = btn.IsChecked; //Save the current state
    }

They are bound with controls here:

<ControlTemplate TargetType="{x:Type GroupItem}">
    <Grid Loaded="Grid_Loaded">

and here:

<ToggleButton x:Name="btnShowHide" Click="btnShowHide_Click" IsChecked="True" Margin="3.5" />

If you define Template for GroupItem somewhere in an external dictionary, you must use UserControl for the purpose of having access to code-behind.