DxGrid.SelectAllAsync(Boolean) Method

Selects or deselects all rows in the grid.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v23.2.dll

NuGet Package: DevExpress.Blazor

Declaration

public Task SelectAllAsync(
    bool selected = true
)

Optional Parameters

Name	Type	Default	Description
selected	Boolean	True	true to select rows; false to deselect rows.

Returns

Type	Description
Task	The task that is completed when all rows are selected.

Remarks

The following methods allow you to manage Grid selection:

• SelectRow (DeselectRow)
• SelectRows (DeselectRows)
• SelectDataItem (DeselectDataItem)
• SelectDataItems (DeselectDataItems)
• SelectAllOnPage (DeselectAllOnPage)
• SelectAllAsync (DeselectAllAsync)
• ClearSelection

Call the SelectAllAsync method to select or deselect all rows in the grid. This method does not affect the selection state of the rows hidden by a filter.

If you call the SelectAllAsync(true) method when the SelectionMode property is set to Single, the method clears selection and selects only the last grid row.

To deselect all rows, call the SelectAllAsync(false) or DeselectAllAsync() method.

To access data items that correspond to selected rows, implement two-way binding for the SelectedDataItems property or handle the SelectedDataItemsChanged event.

<DxGrid Data="@Products" @ref="Grid" KeyFieldName="ProductId" 
        AllowSelectRowByClick="true" @bind-SelectedDataItems="@SelectedDataItems">
    <Columns>
        <DxGridDataColumn FieldName="ProductName" />
        <DxGridDataColumn FieldName="Category"/>
        <DxGridDataColumn FieldName="UnitPrice" DisplayFormat="c" />
        <DxGridDataColumn FieldName="UnitsInStock" />
    </Columns>
</DxGrid>
<DxButton Click="SelectAll">Select All Rows</DxButton>
<DxButton Click="DeselectAll">Deselect All Rows</DxButton>

@code {
    IEnumerable<Product> Products { get; set; }
    IReadOnlyList<object> SelectedDataItems { get; set; }
    IGrid Grid { get; set; }

    protected override async Task OnInitializedAsync() {
        Products = await NwindDataService.GetProductsAsync();
    }
    async Task SelectAll(MouseEventArgs args) {
        await Grid.SelectAllAsync();
    }
    async Task DeselectAll(MouseEventArgs args) {
        await Grid.DeselectAllAsync();
    }
}

Run Demo: Data Grid - Selection API

Large Data Limitation

• The SelectAllAsync and DeselectAllAsync methods load all data to the grid. If you bind the grid to a Server Mode or custom data source, the methods can reduce overall performance and increase memory consumption.

• When the grid is bound to an instant feedback data source or to a GridDevExtremeDataSource object, the second call to the SelectAllAsync or DeselectAllAsync method cancels the operation initiated by the previously called method.

• When the grid is bound to an instant feedback data source or to a GridDevExtremeDataSource object, sorting, filtering, or grouping data during the select all or deselect all operation processing, cancels the operation.

For more information about selection in the Grid component, refer to the following topic: Selection and Focus in Blazor Grid.

Implements

SelectAllAsync(Boolean)