Class TreeGridAggregateColumnBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
TreeGridAggregateColumnBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridAggregateColumnBuilder : ControlBuilder
Constructors
TreeGridAggregateColumnBuilder()
Declaration
public TreeGridAggregateColumnBuilder()
TreeGridAggregateColumnBuilder(List<TreeGridAggregateColumn>)
Declaration
public TreeGridAggregateColumnBuilder(List<TreeGridAggregateColumn> collection)
Parameters
Methods
Add()
Declaration
ColumnName(String)
Specifies the column name to display the aggregate value. If not defined, the field name is used by default.
Declaration
public TreeGridAggregateColumnBuilder ColumnName(string columnName)
Parameters
| Type |
Name |
Description |
| System.String |
columnName |
|
Returns
CustomAggregate(Object)
Defines a custom function to calculate the aggregate value. The type must be set to custom.
Use the custom value as ${custom} in templates.
Total aggregation: The custom function is called with the entire dataset and the current AggregateColumn object.
Group aggregation: It is called with the current group details and the AggregateColumn object.
Declaration
public TreeGridAggregateColumnBuilder CustomAggregate(object customAggregate)
Parameters
| Type |
Name |
Description |
| System.Object |
customAggregate |
|
Returns
CustomAggregate(String)
Defines a custom function to calculate the aggregate value. The type must be set to custom.
Use the custom value as ${custom} in templates.
Total aggregation: The custom function is called with the entire dataset and the current AggregateColumn object.
Group aggregation: It is called with the current group details and the AggregateColumn object.
Declaration
public TreeGridAggregateColumnBuilder CustomAggregate(string customAggregate)
Parameters
| Type |
Name |
Description |
| System.String |
customAggregate |
|
Returns
Field(String)
Specifies the column name on which to perform the aggregation.
Declaration
public TreeGridAggregateColumnBuilder Field(string field)
Parameters
| Type |
Name |
Description |
| System.String |
field |
|
Returns
Defines a template for the footer cell of the aggregate column.
Use the aggregate type names within the template to access aggregate values.
Declaration
public TreeGridAggregateColumnBuilder FooterTemplate(string footerTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
footerTemplate |
|
Returns
Specifies the format to be applied to the calculated aggregate value before display.
Supports both standard and custom formats for numbers and dates.
Refer to the Syncfusion documentation for number
and date formats.
Declaration
public TreeGridAggregateColumnBuilder Format(string format)
Parameters
| Type |
Name |
Description |
| System.String |
format |
|
Returns
Type(String)
Defines the aggregate type(s) for a particular column.
To apply multiple aggregates to a single column, specify the type as an array.
Available aggregate types include:
sum: Calculates the sum of all values in a column.
average: Computes the average of the column values.
max: Finds the maximum value in a column.
min: Finds the minimum value in a column.
count: Counts the number of records.
falsecount: Counts the number of false values.
truecount: Counts the number of true values.
custom: Allows for a custom aggregate function.
Declaration
public TreeGridAggregateColumnBuilder Type(string type)
Parameters
| Type |
Name |
Description |
| System.String |
type |
|
Returns
