GridOptionsBehavior.AutoUpdateTotalSummary Property

Gets or sets whether total summaries are automatically updated to reflect changes in column values.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[DefaultValue(true)]
[XtraSerializableProperty]
public virtual bool AutoUpdateTotalSummary { get; set; }
<DefaultValue(True)>
<XtraSerializableProperty>
Public Overridable Property AutoUpdateTotalSummary As Boolean

Property Value

Type Default Description
Boolean

true

true, if automatic total summary updates are enabled; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type Path to AutoUpdateTotalSummary
AdvBandedGridView
.OptionsBehavior.AutoUpdateTotalSummary
BandedGridView
.OptionsBehavior.AutoUpdateTotalSummary
GridView
.OptionsBehavior.AutoUpdateTotalSummary

Remarks

You can use a column's GridColumn.SummaryItem property to define an aggregate function to be calculated by column values and to format its resulting value. The formatted value will be displayed within the column's corresponding view footer cell.

By default, the AutoUpdateTotalSummary property is set to true. If there is a summary item calculated against a specific column and a cell value in this column is changed, the grid automatically updates the summary in the following cases:

  • On moving focus to another row.
  • On pressing the End Edit button in the Data Navigator.

However, you may want to disable this behavior. For example, disabling automatic summary value recalculation results in performance benefits when working with large data arrays. In this case, you need to update the total summary manually, when required, via the GridView.UpdateTotalSummary method.

See Also