All docs
V21.2
21.2
21.1
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

GridSummaryItem.Mode Property

Gets or sets whether to calculate the current summary against all rows or the selection. Use this property when you enable multiple row selection (see ColumnView.OptionsSelection.MultiSelect). This property is not supported in server mode.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v21.2.dll

Declaration

[DefaultValue(SummaryMode.AllRows)]
[DXCategory("Behavior")]
[XtraSerializableProperty(2)]
public virtual SummaryMode Mode { get; set; }

Property Value

Type Default Description
SummaryMode

AllRows

A value that specifies whether the current summary is calculated against all rows or the selection.

Available values:

Name Description
AllRows

Calculate a summary against all rows.

Selection

Calculate a summary against the selection.

Mixed

Mixed mode. If a single row is selected, calculate a summary against all rows. If 2 or more rows are selected, calculate the summary against the selection.

Remarks

In multiple row selection mode (see ColumnView.OptionsSelection.MultiSelect), summaries are initially calculated against all rows. To calculate summaries against the selected rows, set the GridSummaryItem.Mode property to SummaryMode.Selection or SummaryMode.Mixed.

Note

Controls bound to large data sources in server mode do not support the SummaryMode.Selection and SummaryMode.Mixed options.

using DevExpress.Data;
using DevExpress.XtraGrid;

gridView1.OptionsView.ShowFooter = true;
gridView1.OptionsSelection.MultiSelect = true;
colOrderID.Summary.AddRange(new GridSummaryItem[] {new GridColumnSummaryItem(SummaryItemType.Count, SummaryMode.Selection, "ProductName", "COUNT={0}")});

image

Selection and Mixed modes produce different results when you select a single data row. The summary is calculated against the selected row in Selection mode, and against all rows in Mixed mode.

image

The Data Grid control displays a special icon to indicate summaries calculated against a subset of rows:

image

The Data Grid does not use additional icons for summaries calculated against all rows.

image

Note

You can set the GridView.OptionsSelection.MultiSelectMode property to CellSelect to allow a user to select multiple cells. The Data Grid calculates summaries against the rows that contain the selected cells, but not against individual cells.

image

Data Grouping

When a user selects one or more group rows, summaries (in Selection or Mixed mode) are calculated across all children of the selected groups.

image

If you select a data row(s) within a group, the summary ignores non-selected rows in this group.

image

Change Summary Mode at Runtime

Enable the GridOptionsMenu.ShowSummaryItemMode option to allow users to specify summary mode at runtime via a context menu.

image

See Also