ASPxClientGridViewBatchEditApi.GetGroupSummaryValue(groupRowVisibleIndex, summaryItemIndex) Method

Returns the group summery value.

Declaration

GetGroupSummaryValue(
    groupRowVisibleIndex: number,
    summaryItemIndex: number | string
): number

Parameters

Name	Type	Description
groupRowVisibleIndex	number	The group row’s visible index.
summaryItemIndex	string | number	The summary’s index or field name.

Returns

Type	Description
number	The group summary value.

Remarks

The example below illustrates how to use the GetGroupSummaryValue method.

ASPX

<dx:ASPxGridView ID="Grid" runat="server" ClientInstanceName="grid" ... >
    // ...
    <SettingsEditing Mode="Batch" />
    <ClientSideEvents BatchEditEndEditing="onBatchEditEndEditing" BatchEditSummaryDisplayText="onBatchEditSummaryDisplayText" />
    <GroupSummary>
        <dx:ASPxSummaryItem FieldName="ProductName" SummaryType="Count" />
        <dx:ASPxSummaryItem FieldName="Discount" SummaryType="Max" DisplayFormat="Max Discount = {0:p0}" />
        <dx:ASPxSummaryItem FieldName="Total" SummaryType="Sum" />
    </GroupSummary>
    // ...
</dx:ASPxGridView>

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

JS

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

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