Skip to main content
A newer version of this page is available. .

DxGrid.SelectAllCheckboxMode Property

Specifies whether the Select All checkbox selects all rows on the current page or on all grid pages.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v22.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(GridSelectAllCheckboxMode.Page)]
[Parameter]
public GridSelectAllCheckboxMode SelectAllCheckboxMode { get; set; }

Property Value

Type Default Description
GridSelectAllCheckboxMode Page

The selection mode.

Available values:

Name Description
Page

The Select All checkbox selects and deselects all rows on the current grid page.

AllPages

The Select All checkbox selects and deselects all rows on all grid pages.

Mixed

The Select All checkbox selects and deselects all rows on the current grid page. An additional drop-down button displays a context menu that allows users to select and deselect all rows on all grid pages.

Remarks

When you declare a DxGridSelectionColumn object in the Columns template, the grid displays the selection column. The column header contains the Select All checkbox. Use the SelectAllCheckboxMode property to specify whether the checkbox selects all rows on the current page or on all grid pages. Note that the Select All checkbox does not affect the selection state of the filtered rows.

To hide the Select All checkbox, set the AllowSelectAll property to false.

Use the SelectedDataItems property to access data items that correspond to the selected rows.

<DxGrid Data="Products"
        KeyFieldName="ProductId"
        PageSize="6"
        SelectAllCheckboxMode="GridSelectAllCheckboxMode.Mixed">
    <Columns>
        <DxGridSelectionColumn />
        <DxGridDataColumn FieldName="ProductName" />
        <DxGridDataColumn FieldName="UnitPrice" DisplayFormat="c" />
        <DxGridDataColumn FieldName="UnitsInStock" />
        <DxGridDataColumn FieldName="QuantityPerUnit" />
    </Columns>
</DxGrid>

Grid Select All Checkbox

When the SelectionMode property is set to Single, the SelectAllCheckboxMode property has no effect.

Run Demo: Grid - Selection Column View Example: Grid - Select and Deselect All Rows in a Group

See Also