ASPxClientVerticalGridBatchEditApi.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 value.

Remarks

In the batch edit mode, the ASPxVerticalGrid control allows you to get the specified total summary value on the client side.

ASPX

<dx:ASPxVerticalGrid ID="VerticalGrid" runat="server" ClientInstanceName="verticalGrid" ... >
    // ...
    <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:ASPxVerticalGrid>

<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 = verticalGrid.GetTotalSummaryValue('ProductName');
    // ...

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