Class SummaryCreator

Inheritance

System.Object

SummaryCreator

Namespace: Syncfusion.Data

Assembly: Syncfusion.Data.Portable.dll

Syntax

public static class SummaryCreator : Object

Fields

ColumnName

Maintains the column name.

Declaration

public static string ColumnName

Field Value

Type
System.String

ItemsCount

Maintains the group item count.

Declaration

public static string ItemsCount

Field Value

Type
System.String

Key

Maintains the key.

Declaration

public static string Key

Field Value

Type
System.String

Methods

GetSummaryAggregate(ISummaryColumn, ICollectionViewAdv, DataTable)

Gets the summary aggregate for the given summary column and the underlying collection of the group.

Declaration

public static ISummaryAggregate GetSummaryAggregate(ISummaryColumn summaryColumn, ICollectionViewAdv collectionView, DataTable summaryCalculationTable = null)

Parameters

Type	Name	Description
ISummaryColumn	summaryColumn	The summary column for which the summary aggregate is to be obtained.
ICollectionViewAdv	collectionView	The underlying collection view of the group.
System.Data.DataTable	summaryCalculationTable	The dataTable for TableSummary calculation

Returns

Type	Description
ISummaryAggregate	The summary aggregate for the given summary column and the underlying collection of the group.

GetSummaryDisplayText(SummaryRecordEntry, String, ICollectionViewAdv)

Gets the summary display text based on the given values.

Declaration

public static string GetSummaryDisplayText(SummaryRecordEntry summaryEntry, string columnName, ICollectionViewAdv collectionView)

Parameters

Type	Name	Description
SummaryRecordEntry	summaryEntry	The summary record entry which contains the information of the summary values of the group.
System.String	columnName	The column header name of the grouped column.
ICollectionViewAdv	collectionView	The underlying collection view of the group.

Returns

Type	Description
System.String	The summary display text based on the given values.

GetSummaryDisplayText(SummaryRecordEntry, String, ICollectionViewAdv, Group)

Gets the summary display text based on the given values.

Declaration

public static string GetSummaryDisplayText(SummaryRecordEntry summaryEntry, string columnName, ICollectionViewAdv collectionView, Group group)

Parameters

Type	Name	Description
SummaryRecordEntry	summaryEntry	The summary record entry which contains the information of the summary values of the group.
System.String	columnName	The column header name of the grouped column.
ICollectionViewAdv	collectionView	The underlying collection view of the group.
Group	group	The group for which the summary is to be obtained.

Returns

Type	Description
System.String	The summary display text based on the given values.

GetSummaryDisplayTextForRow(SummaryRecordEntry, ICollectionViewAdv, String)

Gets the summary display text for the summary row based on the given values.

Declaration

public static string GetSummaryDisplayTextForRow(SummaryRecordEntry summaryEntry, ICollectionViewAdv collectionView, string columnHeaderName = null)

Parameters

Type	Name	Description
SummaryRecordEntry	summaryEntry	The summary record entry which contains the information of the summary values of the group.
ICollectionViewAdv	collectionView	The underlying collection view of the group.
System.String	columnHeaderName	The column header name of the grouped column.

Returns

Type	Description
System.String	The summary display text for the summary row based on the given values.

GetSummaryDisplayValue(SummaryRecordEntry, String, String)

Gets the summary display value based on the given values.

Declaration

public static object GetSummaryDisplayValue(SummaryRecordEntry summaryEntry, string columnName, string aggregateKey)

Parameters

Type	Name	Description
SummaryRecordEntry	summaryEntry	The summary record entry which contains the information of the summary values of the group.
System.String	columnName	The column header name of the grouped column.
System.String	aggregateKey	The aggregate key based on which the summary is to be calculated.

Returns

Type	Description
System.Object	The summary display value based on the given values.

RaiseQuerySummaryAggregate(IEnumerable, ISummaryColumn, Dictionary<String, Object>, ICollectionViewAdv, DataTable)

Queries the summary aggregate based on the given values and gets the formatted summary of the summary column.

Declaration

public static object RaiseQuerySummaryAggregate(IEnumerable items, ISummaryColumn summaryColumn, Dictionary<string, object> summaries, ICollectionViewAdv collectionView, DataTable summaryCalculationTable = null)

Parameters

Type	Name	Description
System.Collections.IEnumerable	items	The IEnumerable items of the group.
ISummaryColumn	summaryColumn	The summary column of the summary row.
System.Collections.Generic.Dictionary<System.String, System.Object>	summaries	The summaries which contains the summary values of the group.
ICollectionViewAdv	collectionView	The collection view of the group.
System.Data.DataTable	summaryCalculationTable	The dataTable for Table summary calculation.

Returns

Type	Description
System.Object	The formatted summary calculated for the summary column based on the queried summary aggregate and given values.