GridViewBatchEditSettings.HighlightSummaryItems Property

Specifies whether the grid highlights summaries when their values are updated.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.2.dll

Declaration

C#

[DefaultValue(false)]
public bool HighlightSummaryItems { get; set; }

VB.NET

<DefaultValue(False)>
Public Property HighlightSummaryItems As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true, to highlight updated summaries; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to HighlightSummaryItems
ASP.NET Controls and MVC Extensions	ASPxGridViewEditingSettings	.BatchEditSettings.HighlightSummaryItems
	MVCxGridViewEditingSettings	.BatchEditSettings.HighlightSummaryItems
ASP.NET Bootstrap Controls	BootstrapGridViewEditingSettings	.BatchEditSettings.HighlightSummaryItems

Remarks

The grid does not highlight its summaries when their values are recalculated in real time (EnableRealTimeSummaryRecalculation). To enable this functionality, set the HighlightSummaryItems property to true. The grid applies the following colors to summary values:

• Green - The grid recalculated a summary value successfully.

• Red - The grid failed to recalculate a summary value. A callback is required.

• Grey - The grid failed to recalculate a summary value due to limitations.

Note

The grid highlights summary values only after a user modifies grid data cells.

ASPX

<dx:ASPxGridView ID="GridView" runat="server" ...>
      ...
    <SettingsEditing Mode="Batch">
        <BatchEditSettings HighlightSummaryItems="True" />
    </SettingsEditing>
</dx:ASPxGridView>

Alternatively, you can handle the BatchEditSummaryDisplayText client-side event to specify custom visual styles.

JS

function onBatchEditSummaryDisplayText(s, e) {
    if (e.summaryFieldName === "Total") {
        var isValueChanged = e.value !== e.serverValue;
        var hasLargeValue = e.value > 1300000;
        ASPxClientUtils.ToggleClassName(e.summaryElement, "summaryItemChangedValue", isValueChanged);
        ASPxClientUtils.ToggleClassName(e.summaryElement, "summaryItemLargeValue", hasLargeValue);
    }
}

Result:

Note

The BatchEditSummaryDisplayText event has higher priority over the HighlightSummaryItems property setting.

Online Demo

Client Summary Calculation