Skip to main content

ASPxClientVerticalGridBatchEditApi.GetTotalSummaryValue(summaryItemIndex) Method

Returns the total summary value.

Declaration

GetTotalSummaryValue(
    summaryItemIndex: number | string
): number

Parameters

Name Type Description
summaryItemIndex number | string

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.

<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>
See Also