Class GridAggregateColumn

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

GridAggregateColumn

Namespace: Syncfusion.EJ2.Grids

Assembly: Syncfusion.EJ2.dll

Syntax

public class GridAggregateColumn : EJTagHelper

Constructors

GridAggregateColumn()

Declaration

public GridAggregateColumn()

Properties

ColumnName

Defines the column name to display the aggregate value. If columnName is not defined, then field name value will be assigned to the columnName property.

Declaration

public string ColumnName { get; set; }

Property Value

Type	Description
System.String	The default value is null

CustomAggregate

Defines a function to calculate custom aggregate value. The type value should be set to custom. To use custom aggregate value in the template, use the key as ${custom}. Total aggregation: The custom function will be called with the whole data and the current AggregateColumn object. Group aggregation: This will be called with the current group details and the AggregateColumn object.

Declaration

public object CustomAggregate { get; set; }

Property Value

Type	Description
System.Object	The default value is null

CustomFormat

It is used to change display value with the given format and does not affect the original data. Gets the format from the user which can be standard or custom number and date formats.

Declaration

public object CustomFormat { get; set; }

Property Value

Type
System.Object

Field

Defines the column name to perform aggregation.

Declaration

public string Field { get; set; }

Property Value

Type	Description
System.String	The default value is null

FooterTemplate

Defines the footer cell template as a string for the aggregate column. The type name should be used to access aggregate values inside the template.

Declaration

public string FooterTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

Format

Declaration

public string Format { get; set; }

Property Value

Type	Description
System.String	The default value is null

GroupCaptionTemplate

Defines the group caption cell template as a string for the aggregate column. The type name should be used to access aggregate values inside the template. Additionally, the following fields can be accessed in the template. field: The current grouped field name. key: The current grouped field value.

Declaration

public string GroupCaptionTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

GroupFooterTemplate

Defines the group footer cell template as a string for the aggregate column. The type name should be used to access aggregate values inside the template. Additionally, the following fields can be accessed in the template. field: The current grouped field. key: The current grouped value.

Declaration

public string GroupFooterTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

Type

Defines the aggregate type of a particular column. To use multiple aggregates for single column, specify the type as array. Types of aggregate are, sum average max min count truecount falsecount custom

Specify the type value as custom to use custom aggregation.

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.String	The default value is null

Types

Defines the aggregate type of a particular column. To use multiple aggregates for single column, specify the types as array. Types of aggregate are, sum average max min count truecount falsecount custom

Specify the types value as custom to use custom aggregation.

Declaration

public object Types { get; set; }

Property Value

Type	Description
System.Object	The default value is null