CollapseGroup Method (DataGridContext)

Collapses the specified group.

Overload List

Overload	Description
CollapseGroup(CollectionViewGroup)

Exceptions

Exception	Description
System.InvalidOperationException	The specified CollectionViewGroup is not part of the current context.

Remarks

The state of child groups will not be affected if their parent is collapsed.

Example

All examples in this topic assume that the grid is bound to the Orders table of the Northwind database, unless stated otherwise.

The following example demonstrates how to retrieve the parent group of the current item using the GetParentGroupFromItem method so that it can be collapsed. The implementation for the CollapseCurrentGroup method is provided below.

XAML

<Grid xmlns:xcdg="http://schemas.xceed.com/wpf/xaml/datagrid">
  <Grid.Resources>
    <xcdg:DataGridCollectionViewSource x:Key="cvs_orders"
                                     Source="{Binding Source={x:Static Application.Current},
                                                      Path=Orders}">
      <xcdg:DataGridCollectionViewSource.GroupDescriptions>
        <xcdg:DataGridGroupDescription PropertyName="ShipCountry"/>
        <xcdg:DataGridGroupDescription PropertyName="ShipCity"/>
      </xcdg:DataGridCollectionViewSource.GroupDescriptions>
    </xcdg:DataGridCollectionViewSource>
  </Grid.Resources>
  <DockPanel>

    <Button Content="Collapse Group"
             Click="CollapseCurrentGroup"
            DockPanel.Dock="Top"/>
    <xcdg:DataGridControl x:Name="OrdersGrid"
                          ItemsSource="{Binding Source={StaticResource cvs_orders}}"
                          DockPanel.Dock="Bottom"/>
  </DockPanel>
</Grid>

The following provides the implementation for the CollapseCurrentGroup method.

Visual Basic

Private Sub CollapseCurrentGroup( ByVal sender As Object, ByVal e As RoutedEventArgs )

  Dim context As DataGridContext = Me.OrdersGrid.CurrentContext

  Dim group As CollectionViewGroup = context.GetParentGroupFromItem( context.CurrentItem )
  context.CollapseGroup( group )
End Sub

The following provides the implementation for the CollapseCurrentGroup method.

private void CollapseCurrentGroup( object sender, RoutedEventArgs e )
{

  DataGridContext context = this.OrdersGrid.CurrentContext;
  CollectionViewGroup group = context.GetParentGroupFromItem( context.CurrentItem );
  context.CollapseGroup( group );
}

Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DataGridContext Class
DataGridContext Members