DxGrid.CustomSummary Event

Allows you to create custom summary items.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[Parameter]
public Action<GridCustomSummaryEventArgs> CustomSummary { get; set; }

Parameters

Type	Description
GridCustomSummaryEventArgs	An object that contains data for this event.

Remarks

Grid allows you to calculate group and total summaries based on custom logic. To create a custom summary, follow the steps below:

1. Declare a DxGridSummaryItem object in the GroupSummary or TotalSummary template.
2. Set the SummaryType property to Custom.

3. Handle the Grid’s CustomSummary event to implement summary calculation algorithm.

   The CustomSummary event occurs multiple times as follows:

   • Once, before grid rows are processed. The event argument’s SummaryStage property returns Start. At this stage, you can initialize a summary value.
   • For each data row in the processed range. The SummaryStage property returns Calculate. At this stage, you can calculate a summary value.
   • Once, after grid rows are processed. The SummaryStage property returns Finalize. At this stage, you can finalize summary calculation.

4. (Optional). If the summary value can change dynamically, call the RefreshSummary() method to refresh grid summary values.

5. (Optional). Specify the summary item’s DisplayText property or handle the CustomizeSummaryDisplayText event to change the summary’s display text.

Run Demo: Grid - Custom Summary

<DxGrid @ref="Grid"
        Data="@Data"
        SelectedDataItems="@SelectedDataItems"
        SelectedDataItemsChanged="Grid_SelectedDataItemsChanged"
        CustomSummary="Grid_CustomSummary"
        CustomizeSummaryDisplayText="Grid_CustomizeSummaryDisplayText">
    <Columns>
        <DxGridSelectionColumn />
        <DxGridDataColumn FieldName="OrderId" Caption="Order ID"/>
        <DxGridDataColumn FieldName="CustomerId" Caption="Customer">
            <EditSettings>
                <DxComboBoxSettings Data="Customers" ValueFieldName="CustomerId" TextFieldName="ContactName"/>
            </EditSettings>
        </DxGridDataColumn>
        <DxGridDataColumn FieldName="OrderDate" />
        <DxGridDataColumn FieldName="ShipCountry" />
        <DxGridDataColumn FieldName="ShipCity" />
        <DxGridDataColumn FieldName="ShippedDate" />
        <DxGridDataColumn FieldName="Total" DisplayFormat="c" />
    </Columns>
    <TotalSummary>
        <DxGridSummaryItem SummaryType="GridSummaryItemType.Custom" Name="Custom" FieldName="Total" />
        <DxGridSummaryItem SummaryType="GridSummaryItemType.Sum"
                           FieldName="Total"
                           DisplayText="Grand Total: {0}"
                           ValueDisplayFormat="c0" />
    </TotalSummary>
</DxGrid>

@code {
    IEnumerable<object> Data { get; set; }
    IReadOnlyList<Customer> Customers { get; set; }
    IReadOnlyList<object> SelectedDataItems { get; set; }
    IGrid Grid { get; set; }
    @* ... *@
    void Grid_CustomSummary(GridCustomSummaryEventArgs e) {
        switch(e.SummaryStage) {
            case GridCustomSummaryStage.Start:
                e.TotalValue = 0m;
                break;
            case GridCustomSummaryStage.Calculate:
                if(e.Grid.IsDataItemSelected(e.DataItem))
                    e.TotalValue = (decimal)e.TotalValue + (decimal)e.GetRowValue("Total");
                break;
        }
    }
    void Grid_CustomizeSummaryDisplayText(GridCustomizeSummaryDisplayTextEventArgs e) {
        if(e.Item.Name == "Custom")
            e.DisplayText = string.Format("Sum of Selected ({0}): {1:c0}", SelectedDataItems.Count, e.Value);
    }
    void Grid_SelectedDataItemsChanged(IReadOnlyList<object> newSelection) {
        SelectedDataItems = newSelection;
        Grid.RefreshSummary();
    }
}

Limitations

• Grid does not support custom summary when you use GridDevExtremeDataSource.

• If you use Server Mode data source, the CustomSummary event fires only once. The SummaryStage property returns Finalize.

For more information about summaries in the Grid component, refer to the following topic: Summary in Blazor Grid.