Xceed DataGrid for WPF v7.3 Documentation
Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid Namespace / DataGridContext Class / ToggleGroupExpansion Method
A CollectionViewGroup representing the group whose state is to be toggled. A collapsed group will be expanded and an expanded group will be collapsed.
Example


In This Topic
    ToggleGroupExpansion Method (DataGridContext)
    In This Topic
    Toggles the specified group.
    Syntax
    'Declaration
     
    Public Function ToggleGroupExpansion( _
       ByVal group As CollectionViewGroup _
    ) As Boolean
    'Usage
     
    Dim instance As DataGridContext
    Dim group As CollectionViewGroup
    Dim value As Boolean
     
    value = instance.ToggleGroupExpansion(group)
    public bool ToggleGroupExpansion( 
       CollectionViewGroup group
    )

    Parameters

    group
    A CollectionViewGroup representing the group whose state is to be toggled. A collapsed group will be expanded and an expanded group will be collapsed.

    Return Value

    true if the group was found; false, otherwise.
    Remarks
    The state of child groups will not be affected if their parent's state is toggled.
    Example
    All examples in this topic assume that the grid is bound to the Orders or Employees table of the Northwind database, unless stated otherwise.
    The following example demonstrates how to handle the PreviewMouseLeftButtonDown event on the GroupHeaderControl objects contained in the headers of the child groups to toggle the expansion state of child groups using the ToggleGroupExpansion method. The group whose state is to be toggled will be retrieved using the GetParentGroupFromItem method.The following code provides the implementation of the PreviewMouseLeftButtonDown event in which we will retrieve the item represented by the GroupHeaderControl (GroupHeaderFooterItem) using the GetItemFromContainer method, which will then be used to retrieve the parent group (GetParentGroupFromItem) whose state is to be toggled.The following code provides the implementation of the PreviewMouseLeftButtonDown event in which we will retrieve the item represented by the GroupHeaderControl (GroupHeaderFooterItem) using the GetItemFromContainer method, which will then be used to retrieve the parent group (GetParentGroupFromItem) whose state is to be toggled.
    <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>
        <Style TargetType="{x:Type xcdg:GroupHeaderControl}">
          <EventSetter Event="PreviewMouseLeftButtonDown"
                       Handler="HeaderDown"/>
        </Style>   
    </Grid.Resources>
      <xcdg:DataGridControl x:Name="OrdersGrid"
                            ItemsSource="{Binding Source={StaticResource cvs_orders}}"/>
    </Grid>
    Private Sub HeaderDown( ByVal sender As Object, ByVal e As MouseEventArgs )
    
      Dim headerControl As GroupHeaderControl = TryCast( sender, GroupHeaderControl );
      If header Is Nothing Then
        Return
      End If
    
      Dim context As DataGridContext = DataGridControl.GetDataGridContext( headerControl )
      Dim item As Object = context.GetItemFromContainer( headerControl ) )
    
      If Not item Is Nothing Then
        Dim group As CollectionViewGroup = context.GetParentGroupFromItem( item )
        If Not group Is Nothing
          context.ToggleGroupExpansion( group )
        End If
      End If
    End Sub
    private void HeaderDown( object sender, MouseEventArgs e )
    {
      GroupHeaderControl headerControl = sender as GroupHeaderControl;
      if( headerControl == null )
        return;
      DataGridContext context = DataGridControl.GetDataGridContext( headerControl );
      object item = context.GetItemFromContainer( headerControl );
      if( item != null )
      {
        CollectionViewGroup group = context.GetParentGroupFromItem( item );
        if( group != null )
        {
          context.ToggleGroupExpansion( 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

    See Also