VerticalGridBatchEditSettings.HighlightSummaryItems Property

Specifies whether the vertical grid highlights summaries when their values are recalculated.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

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 summaries; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to HighlightSummaryItems
ASPxVerticalGridEditingSettings	.BatchEditSettings .HighlightSummaryItems

Remarks

The vertical grid with default settings does not highlight its summaries when their values are recalculated in real time (EnableRealTimeSummaryRecalculation).

You can do one of the following to highlight recalculated summaries:

• Set the HighlightSummaryItems property to true to use the predefined style settings.

ASPX

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

• 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);
    }
}

Note

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