Multiple Row Selection via Built-In Check Column and Selection Binding

  • 3 minutes to read

The GridView, BandedGridView, and AdvBandedGridView views support multiple row selection via a built-in Check column. When this feature is enabled, end-users can use checkboxes to toggle the selection state of certain rows, all rows or data group rows.

Selection_MultipleRowSelection_CheckBox

Demo: Web Style Row Selection module in the XtraGrid MainDemo

Enable Built-In Check Column

To enable row selection via the built-in Check column, set the properties as follows:


gridView1.OptionsSelection.MultiSelect = true
gridView1.OptionsSelection.MultiSelectMode = GridMultiSelectMode.CheckBoxRowSelect

Check Column Specifics

Check Box in Column Header

CheckBoxColumn-Header.png

The checkbox in the Check column header allows you to select/deselect all grid rows. Use the GridOptionsSelection.ShowCheckBoxSelectorInColumnHeader property to hide this checkbox.

Check Boxes in Group Rows

Group rows can also contain checkboxes if the GridOptionsSelection.ShowCheckBoxSelectorInGroupRow property value is True. These checkboxes switch the selection states of rows that belong to specific groups.

Selection_MultipleRowSelection_CheckBox_GroupRows

Sync Selection with Data Source

Specify the GridOptionsSelection.CheckBoxSelectorField property to bind the Check column to a field in the bound data source. When you change a row's selection state (via the Check column or in code), the grid automatically updates the specified data source field.

Check column bound mode provides the following advantages, in contrast to the default (unbound) mode:

TIP

In Check column bound mode, multiple row selection may lead to performance issues due to excessive data source updates. For instance, this may occur when clicking the check box embedded in the Check column's header for a grid bound to a large data source. Disable the GridOptionsSelection.ShowCheckBoxSelectorInColumnHeader for large data sources, or alternatively, use the Check column in unbound mode.

NOTE

In Check column bound mode, group rows never display check boxes, regardless of the GridOptionsSelection.ShowCheckBoxSelectorInGroupRow setting.

Checkboxes in Print/Export Documents

The GridOptionsSelection.ShowCheckBoxSelectorInPrintExport property specifies the Check column's visibility in printed/exported documents.

Selection_MultipleRowSelection_CheckBox_PrintPreview

Methods to Work with Selected Rows

See the Multiple Row and Cell Selection topic to learn about the methods used to select rows in code, retrieve and delete the selected rows, or copy them to the Clipboard.

See Also