Xceed DataGrid for WPF v7.3 Documentation
Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid Namespace / GroupByControl Class
Members Example


In This Topic
    GroupByControl Class
    In This Topic
    Represents a control that displays information about how the data items in a grid or detail are grouped and sorted as well as allows the end user to change how the items are grouped and sorted.
    Syntax
    'Declaration
     
    <DefaultEventAttribute("OnItemsChanged")>
    <DefaultPropertyAttribute("Items")>
    <ContentPropertyAttribute("Items")>
    <StyleTypedPropertyAttribute(Property="ItemContainerStyle", StyleTargetType=System.Windows.FrameworkElement)>
    <LocalizabilityAttribute(LocalizationCategory.None, Readability=Readability.Unreadable)>
    <XmlLangPropertyAttribute("Language")>
    <UsableDuringInitializationAttribute(True)>
    <RuntimeNamePropertyAttribute("Name")>
    <UidPropertyAttribute("Uid")>
    <TypeDescriptionProviderAttribute(MS.Internal.ComponentModel.DependencyObjectProvider)>
    <NameScopePropertyAttribute("NameScope", System.Windows.NameScope)>
    Public Class GroupByControl 
       Inherits System.Windows.Controls.ItemsControl
    'Usage
     
    Dim instance As GroupByControl
    [DefaultEvent("OnItemsChanged")]
    [DefaultProperty("Items")]
    [ContentProperty("Items")]
    [StyleTypedProperty(Property="ItemContainerStyle", StyleTargetType=System.Windows.FrameworkElement)]
    [Localizability(LocalizationCategory.None, Readability=Readability.Unreadable)]
    [XmlLangProperty("Language")]
    [UsableDuringInitialization(true)]
    [RuntimeNameProperty("Name")]
    [UidProperty("Uid")]
    [TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
    [NameScopeProperty("NameScope", System.Windows.NameScope)]
    public class GroupByControl : System.Windows.Controls.ItemsControl 
    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 recreate the default card-view header, which contains a ColumnManagerRow to the right of a GroupByControl.
    <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}"/>
      </Grid.Resources>
      <xcdg:DataGridControl x:Name="OrdersGrid"
                            ItemsSource="{Binding Source={StaticResource cvs_orders}}">
        <xcdg:DataGridControl.View>
          <xcdg:CardView UseDefaultHeadersFooters="False">
            <xcdg:CardView.FixedHeaders>
    
             <DataTemplate>
               <DockPanel>
                 <!-- OneWay binding is used because we want the ColumnManagerRow's height to
                      follow what is defined by the GroupByControl. A FallbackValue
                      is specified so the initial measure pass has an acceptable minimal
                      value.-->
                 <xcdg:ColumnManagerRow DockPanel.Dock="Right"
                                        Height="{Binding ElementName=groupByControl,
                                                         Path=ActualHeight,
                                                         Mode=OneWay,
                                                         FallbackValue=60}"/>
                 <xcdg:GroupByControl x:Name="groupByControl"/>
               </DockPanel>
             </DataTemplate>
            </xcdg:CardView.FixedHeaders>
          </xcdg:CardView>
        </xcdg:DataGridControl.View>
      </xcdg:DataGridControl>
    </Grid>
    Inheritance Hierarchy

    System.Object
       System.Windows.Threading.DispatcherObject
          System.Windows.DependencyObject
             System.Windows.Media.Visual
                System.Windows.UIElement
                   System.Windows.FrameworkElement
                      System.Windows.Controls.Control
                         System.Windows.Controls.ItemsControl
                            Xceed.Wpf.DataGrid.GroupByControl

    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