Class GridSummaryRow

Represents a class that implements ISummaryRow that contains properties exposed through ISummaryRow for getting information on the summary values to be computed for the Groups in TopLevelGroup.

Inheritance
System.Object
GridSummaryRow
GridGroupSummaryRow
GridTableSummaryRow
Implements
System.IDisposable
Namespace: Syncfusion.SfDataGrid.XForms
Assembly: Syncfusion.SfDataGrid.XForms.dll
Syntax
public class GridSummaryRow : BindableObject, ISummaryRow, IDisposable

Constructors

GridSummaryRow()

Initializes a new instance of the GridSummaryRow class.

Declaration
public GridSummaryRow()

Properties

Name

Gets or sets the name of the summary row.

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

The name of the summary row.
Examples
GridSummaryRow summaryRow = new GridSummaryRow();
summaryRow.Name = "CaptionSummary";
sfGrid.CaptionSummaryRow= summaryRow;

ShowSummaryInRow

Gets or sets a value indicating whether to show summary in row. By setting the ShowSummaryInRow to true, you can display the summary information in the row, by defining the Title based on Name.

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

True if show summary in row, otherwise false.
Remarks

The caption of the summary can be displayed either in the summary row or summary column, if the caption is displayed in the summary row by setting ShowSummaryInRow as true. The summary row defines the Title which makes use of the Name to display its value.

Examples
GridSummaryRow summaryRow = new GridSummaryRow();
summaryRow.ShowSummaryInRow = true;
summaryRow.Title = "Total Salary:{TotalSalary}";
summaryRow.SummaryColumns.Add(new GridSummaryColumn
{
Name = "TotalSalary",
MappingName = "Salary",
Format = "{Sum:c}",
SummaryType = SummaryType.DoubleAggregate
});
sfGrid.CaptionSummaryRow= summaryRow;
See Also

SummaryColumns

Gets or sets the collection of summary columns in the summary row. The summary columns will be defined and added to the summary row using this property.

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

The collection of summary columns in the summary row.
Examples
GridSummaryRow summaryRow = new GridSummaryRow();
summaryRow.SummaryColumns.Add(new GridSummaryColumn
{
Name = "TotalSalary",
MappingName = "Salary",
Format = "{Sum:c}",
SummaryType = SummaryType.DoubleAggregate
});
sfGrid.CaptionSummaryRow= summaryRow;

Title

Gets or sets the title to be displayed in the summary row. When ShowSummaryInRow is true, the title of the summary row will be displayed.The summary row defines the Title which makes use of the Name to display its value.

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

The title to be displayed in the summary row.
Remarks

The caption of the summary can be displayed either in the summary row or summary column, if the caption is displayed in the summary row by setting ShowSummaryInRow as true. The summary row defines the Title which makes use of the Name to display its value. The title of the summary will be displayed as the caption of the summary row.

Examples
GridSummaryRow summaryRow = new GridSummaryRow();
summaryRow.ShowSummaryInRow = true;
summaryRow.Title = "Total Salary:{TotalSalary}";
summaryRow.SummaryColumns.Add(new GridSummaryColumn
{
Name = "TotalSalary",
MappingName = "Salary",
Format = "{Sum:c}",
SummaryType = SummaryType.DoubleAggregate
});
sfGrid.CaptionSummaryRow= summaryRow;
See Also

Methods

Dispose()

Releases the resources used by the component.

Declaration
public void Dispose()

Dispose(Boolean)

Releases the unmanaged resources used by the component and optionally releases the managed resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

if true - release both managed and unmanaged resources; if false - release only unmanaged resources.

Implements

System.IDisposable