ASPxClientGridViewBatchEditApi.GetTotalSummaryValue(summaryItemIndex) Method

Returns the total summary value.

Declaration

GetTotalSummaryValue(
    summaryItemIndex: number | string
): number

Parameters

Name	Type	Description
summaryItemIndex	string | number	The total summary’s index or field name.

Returns

Type	Description
number	The total summary value.

Remarks

The example below illustrates how to use the GetTotalSummaryValue method.

ASPX

<dx:ASPxGridView ID="Grid" runat="server" ClientInstanceName="grid" ... >
    // ...
    <TotalSummary>
        <dx:ASPxSummaryItem FieldName="ProductName" SummaryType="Count" />
        <dx:ASPxSummaryItem FieldName="Discount" SummaryType="Max" DisplayFormat="Max Discount = {0:p0}" />
        <dx:ASPxSummaryItem FieldName="Total" SummaryType="Sum" />
    </TotalSummary>
    // ...
</dx:ASPxGridView>

<br />
<dx:ASPxButton ID="ASPxButton1" runat="server" AutoPostBack="False" Text="Get summary value" >
    <ClientSideEvents Click="OnClick" />
</dx:ASPxButton>

JS

// The GetTotalSummaryValue method get a field name as a parameter.
function OnClick(s, e) {
    var summaryValue = grid.batchEditApi.GetTotalSummaryValue('ProductName');
    // ...

// The GetTotalSummaryValue method get a summary's index as a parameter.
function OnClick(s, e) {
    var summaryValue = grid.batchEditApi.GetTotalSummaryValue(0);
    // ... 
}