Class GridSummaryRow

Represents a class that defines the summary information of summary row.

Inheritance
System.Object
GridSummaryRow
GridTableSummaryRow
Implements
Namespace: Syncfusion.UI.Xaml.DataGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class GridSummaryRow : DependencyObject, ISummaryRow

Constructors

GridSummaryRow()

Initializes a new instance of GridSummaryRow class.

Declaration
public GridSummaryRow()

Fields

CalculationUnitProperty

Identifies the CalculationUnit dependency property.

Declaration
public static readonly DependencyProperty CalculationUnitProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the CalculationUnit dependency property.

NameProperty

Identifies the Name dependency property.

Declaration
public static readonly DependencyProperty NameProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the Name dependency property.

ShowSummaryInRowProperty

Identifies the ShowSummaryInRow dependency property.

Declaration
public static readonly DependencyProperty ShowSummaryInRowProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the ShowSummaryInRow dependency property.

TitleColumnCountProperty

Identifies the TitleColumnCount dependency property.

Declaration
public static readonly DependencyProperty TitleColumnCountProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the TitleColumnCount dependency property.

TitleProperty

Identifies the Title dependency property.

Declaration
public static readonly DependencyProperty TitleProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the Title dependency property.

Properties

CalculationUnit

Gets or sets the value that specifies the mode for calculating summaries.

Declaration
public SummaryCalculationUnit CalculationUnit { get; set; }
Property Value
Type Description
SummaryCalculationUnit

One of the CalculationUnit that indicates which rows summaries are to be calculated. The default value is AllRows.

Name

Gets or sets the name of the summary row.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

A string that specifies the name of the summary row. The default value is string.Empty.

ShowSummaryInRow

Gets or sets the value that indicates whether the summary value should be displayed in row or based on column.

Declaration
public bool ShowSummaryInRow { get; set; }
Property Value
Type Description
System.Boolean

true if the summary value displayed in a row based on Title property; otherwise, summary value is displayed in column based on MappingName. The default value is true.
Remarks

The Title and Name should have the same name if you want to display the summary value in row basis.

Examples
        
this.dataGrid.TableSummaryRows.Add(new GridSummaryRow()
{
 Name="Total Products",
 ShowSummaryInRow = true,
 Title = "Total Products Count: {ProductCount}",
 SummaryColumns = new ObservableCollection<ISummaryColumn>()
 {
     new GridSummaryColumn()
     {
         Name="ProductCount",
         MappingName="ProductName",
         SummaryType=SummaryType.CountAggregate,
         Format="{Count:d}"
     },
 }
});
See Also

SummaryColumns

Gets or sets the collection of ISummaryColumn.

Declaration
public ObservableCollection<ISummaryColumn> SummaryColumns { get; set; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<ISummaryColumn>

The collection of ISummaryColumn.

Title

Gets or sets the string that has the format and summary column information to be displayed in row.

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

A string that specifies format and summary column name to parse and format summary display text for summary row.The default value is string.Empty.
Remarks

The summary row value is displayed based on Title when the ShowSummaryInRow is true and Title maps the summary value based on Name property.

See Also

TitleColumnCount

Gets or sets the value that maintains the column span of the summary title.

Declaration
public int TitleColumnCount { get; set; }
Property Value
Type Description
System.Int32

The value that specifies the column span of the summary title. The default value is 0.
Remarks

This will be only considered when ShowSummaryInRow is disabled. If TitleColumnCount value is greater than 0, then the Title will be rendered along with summary values as defined through SummaryColumns.

TitleTemplate

Gets or sets the Microsoft.UI.Xaml.DataTemplate used to display the title summary.

Declaration
public DataTemplate TitleTemplate { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.DataTemplate

An instance of DataTemplate.

TitleTemplateSelector

Gets or sets the custom logic to choose a Microsoft.UI.Xaml.DataTemplate used to display the title summary.

Declaration
public DataTemplateSelector TitleTemplateSelector { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.Controls.DataTemplateSelector

An Instance of DataTemplateSelector.

Implements