Class GroupColumnDescription

Represents a class for that contains the grouping information like group column's name and converter based on which grouping for a column is processed in a SfDataGrid.

Inheritance

System.Object

GroupColumnDescription

Namespace: Syncfusion.Maui.DataGrid

Assembly: Syncfusion.Maui.DataGrid.dll

Syntax

public class GroupColumnDescription : BindableObject

Constructors

GroupColumnDescription()

Initializes a new instance of the GroupColumnDescription class.

Declaration

public GroupColumnDescription()

Fields

ColumnNameProperty

Identifies the ColumnName Microsoft.Maui.Controls.BindableProperty.

Declaration

public static readonly BindableProperty ColumnNameProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

This Microsoft.Maui.Controls.BindableProperty is read-only.

ComparerProperty

Identifies the GroupColumnDescription.Comparer Microsoft.Maui.Controls.BindableProperty property.

Declaration

public static readonly BindableProperty ComparerProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

This Microsoft.Maui.Controls.BindableProperty is read-only.

ConverterProperty

Identifies the Converter Microsoft.Maui.Controls.BindableProperty.

Declaration

public static readonly BindableProperty ConverterProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

This Microsoft.Maui.Controls.BindableProperty is read-only.

DisplayNameProperty

Identifies the DisplayName Microsoft.Maui.Controls.BindableProperty.

Declaration

public static readonly BindableProperty DisplayNameProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The Microsoft.Maui.Controls.BindableProperty property specifies the name that will be displayed instead of the column name in the group caption summary text.

KeySelectorProperty

Identifies the KeySelector Microsoft.Maui.Controls.BindableProperty property.

Declaration

public static readonly BindableProperty KeySelectorProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

This Microsoft.Maui.Controls.BindableProperty is read-only.

SortGroupRecordsProperty

Identifies the SortGroupRecords Microsoft.Maui.Controls.BindableProperty property.

Declaration

public static readonly BindableProperty SortGroupRecordsProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

This Microsoft.Maui.Controls.BindableProperty is read-only.

Properties

ColumnName

Gets or sets the column name for grouping. This property represents the MappingName of the column which should be grouped.

Declaration

public string ColumnName { get; set; }

Property Value

Type
System.String

Comparer

Gets or sets the comparer for the apply grouping based on custom logic.

Declaration

public IComparer<object> Comparer { get; set; }

Property Value

Type
System.Collections.Generic.IComparer<System.Object>

Converter

Gets or sets the converter for grouping. This property is used when the user needs to group the column with their custom logic. The user must assign the converter class implementing the IValueConverter to this property.

Declaration

public IValueConverter Converter { get; set; }

Property Value

Type
Microsoft.Maui.Controls.IValueConverter

DisplayName

Gets or sets the name that will be displayed instead of the column name in the group caption summary text if it's not null or empty.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String	It accepts System.String values. The default value is null.

Remarks

This property allows you to customize the display name shown in the group caption summary.

Examples

Here is an example of how to set the DisplayName property in a group column description.

XAML
C#

<dataGrid:SfDataGrid.GroupColumnDescriptions>
    <dataGrid:GroupColumnDescription ColumnName="CustomerName" DisplayName="Name" />
</dataGrid:SfDataGrid.GroupColumnDescriptions>

var groupColumnDescription = new GroupColumnDescription
{
    ColumnName = "CustomerName",
    DisplayName = "Name"
};
sfDataGrid.GroupColumnDescriptions.Add(groupColumnDescription);

KeySelector

Gets or sets the keyselector for applying custom grouping logic. The user must assign the Function System.Func<, , >to this property.

Declaration

public Func<string, object, object> KeySelector { get; set; }

Property Value

Type
System.Func<System.String, System.Object, System.Object>

SortGroupRecords

Gets or sets a value indicating whether to sort the inner records of the group while using custom grouping.

Declaration

public bool SortGroupRecords { get; set; }

Property Value

Type
System.Boolean