ASP.NET MVC - EJ2

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridAggregateColumnBuilder

    Show / Hide Table of Contents

    Class TreeGridAggregateColumnBuilder

    Inheritance
    System.Object
    ControlBuilder
    TreeGridAggregateColumnBuilder
    Inherited Members
    ControlBuilder.Output
    ControlBuilder.Context
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.EJ2.TreeGrid
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class TreeGridAggregateColumnBuilder : ControlBuilder

    Constructors

    TreeGridAggregateColumnBuilder()

    Declaration
    public TreeGridAggregateColumnBuilder()

    TreeGridAggregateColumnBuilder(List<TreeGridAggregateColumn>)

    Declaration
    public TreeGridAggregateColumnBuilder(List<TreeGridAggregateColumn> collection)
    Parameters
    Type Name Description
    System.Collections.Generic.List<TreeGridAggregateColumn> 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 TreeGridAggregateColumnBuilder ColumnName(string columnName)
    Parameters
    Type Name Description
    System.String columnName
    Returns
    Type Description
    TreeGridAggregateColumnBuilder

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

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

    Field(String)

    Defines the column name to perform aggregation.

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

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

    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 TreeGridAggregateColumnBuilder Format(string format)
    Parameters
    Type Name Description
    System.String format
    Returns
    Type Description
    TreeGridAggregateColumnBuilder

    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 falsecount truecount custom

    Specify the type value as custom to use custom aggregation.

    Declaration
    public TreeGridAggregateColumnBuilder Type(string type)
    Parameters
    Type Name Description
    System.String type
    Returns
    Type Description
    TreeGridAggregateColumnBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved