Class GridAggregateColumn

Configures grid aggregate column.

Inheritance

System.Object

GridAggregateColumn

Namespace: Syncfusion.Blazor.Grids

Assembly: Syncfusion.Blazor.dll

Syntax

public class GridAggregateColumn : OwningComponentBase

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
System.String

Field

Defines the column name to perform aggregation.

Declaration

public string Field { get; set; }

Property Value

Type
System.String

FooterTemplate

Defines the cell template for the footer aggregate column. The Type name should be used to access aggregate values inside the template.

Declaration

public RenderFragment<object> FooterTemplate { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

Remarks

The parameters passed to the templates can be accessed using implicit parameter named context. The context is of type AggregateTemplateContext.

Format

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

Declaration

public string Format { get; set; }

Property Value

Type
System.String

GroupCaptionTemplate

Defines the cell template for the group caption aggregate column. The Type name should be used to access aggregate values inside the template.

Declaration

public RenderFragment<object> GroupCaptionTemplate { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

Remarks

The parameters passed to the templates can be accessed using implicit parameter named context. The context is of type AggregateTemplateContext.

GroupFooterTemplate

Defines the cell template for the group footer aggregate column. The Type name should be used to access aggregate values inside the template.

Declaration

public RenderFragment<object> GroupFooterTemplate { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

Remarks

The parameters passed to the templates can be accessed using implicit parameter named context. The context is of type AggregateTemplateContext.

Type

Defines the aggregate type of a particular column. Types of aggregate supported in-built are,.

• SumPerformes sum aggregation.
• AveragePerformes average aggregation.
• CountPerformes count aggregation.
• FalseCountPerformes false count aggregation.
• TrueCountPerformes true count aggregation.
• MaxPerformes max aggregation.
• MinPerformes min aggregation.

Declaration

public object Type { get; set; }

Property Value

Type
System.Object

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
System.Threading.Tasks.Task