ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridAggregateColumnBuilder - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridAggregateColumnBuilder

    Inheritance
    System.Object
    ControlBuilder
    GridAggregateColumnBuilder
    Inherited Members
    ControlBuilder.Output
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.Grids
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class GridAggregateColumnBuilder : ControlBuilder

    Constructors

    GridAggregateColumnBuilder()

    Declaration
    public GridAggregateColumnBuilder()

    GridAggregateColumnBuilder(List<GridAggregateColumn>)

    Declaration
    public GridAggregateColumnBuilder(List<GridAggregateColumn> collection)
    Parameters
    Type Name Description
    System.Collections.Generic.List<GridAggregateColumn> collection

    Methods

    Add()

    Declaration
    public void Add()

    ColumnName(String)

    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 GridAggregateColumnBuilder ColumnName(string columnName)
    Parameters
    Type Name Description
    System.String columnName
    Returns
    Type Description
    GridAggregateColumnBuilder

    CustomAggregate(Object)

    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 GridAggregateColumnBuilder CustomAggregate(object customAggregate)
    Parameters
    Type Name Description
    System.Object customAggregate
    Returns
    Type Description
    GridAggregateColumnBuilder

    CustomAggregate(String)

    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 GridAggregateColumnBuilder CustomAggregate(string customAggregate)
    Parameters
    Type Name Description
    System.String customAggregate
    Returns
    Type Description
    GridAggregateColumnBuilder

    Field(String)

    Defines the column name to perform aggregation.

    Declaration
    public GridAggregateColumnBuilder Field(string field)
    Parameters
    Type Name Description
    System.String field
    Returns
    Type Description
    GridAggregateColumnBuilder

    FooterTemplate(String)

    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 GridAggregateColumnBuilder FooterTemplate(string footerTemplate)
    Parameters
    Type Name Description
    System.String footerTemplate
    Returns
    Type Description
    GridAggregateColumnBuilder

    Format(Object)

    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 GridAggregateColumnBuilder Format(object format)
    Parameters
    Type Name Description
    System.Object format
    Returns
    Type Description
    GridAggregateColumnBuilder

    Format(String)

    Format is applied to a calculated value before it is displayed. Gets the format from the user, which can be standard or custom number and date formats.

    Declaration
    public GridAggregateColumnBuilder Format(string format)
    Parameters
    Type Name Description
    System.String format
    Returns
    Type Description
    GridAggregateColumnBuilder

    GroupCaptionTemplate(String)

    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 GridAggregateColumnBuilder GroupCaptionTemplate(string groupCaptionTemplate)
    Parameters
    Type Name Description
    System.String groupCaptionTemplate
    Returns
    Type Description
    GridAggregateColumnBuilder

    GroupFooterTemplate(String)

    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 GridAggregateColumnBuilder GroupFooterTemplate(string groupFooterTemplate)
    Parameters
    Type Name Description
    System.String groupFooterTemplate
    Returns
    Type Description
    GridAggregateColumnBuilder

    Type(String)

    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 GridAggregateColumnBuilder Type(string type)
    Parameters
    Type Name Description
    System.String type
    Returns
    Type Description
    GridAggregateColumnBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved