Class GridAggregateColumn

Configures grid aggregate column.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
GridAggregateColumn
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class GridAggregateColumn : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

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
[Parameter]
public string? ColumnName { get; set; }
Property Value
Type
string

Field

Defines the column name to perform aggregation.

Declaration
[Parameter]
public string? Field { get; set; }
Property Value
Type
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
[Parameter]
public RenderFragment<object>? FooterTemplate { get; set; }
Property Value
Type
RenderFragment<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
[Parameter]
public string? Format { get; set; }
Property Value
Type
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
[Parameter]
public RenderFragment<object>? GroupCaptionTemplate { get; set; }
Property Value
Type
RenderFragment<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
[Parameter]
public RenderFragment<object>? GroupFooterTemplate { get; set; }
Property Value
Type
RenderFragment<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
[Parameter]
public object? Type { get; set; }
Property Value
Type
object

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Initializes the component asynchronously and updates parent references.

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Handles parameter updates asynchronously and refreshes internal state when bound values change.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements