ColumnView.DeleteSelectedRows() Method

Deletes the selected rows/cards in multiple selection mode or focused row/card in single selection mode.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public virtual void DeleteSelectedRows()

VB.NET

Public Overridable Sub DeleteSelectedRows

Remarks

In single row selection mode, this method deletes the focused row. In multiple row selection mode this method deletes the selected rows. In multiple cell selection mode this method deletes the rows to which selected cells belong.

The current selection mode is determined by the ColumnViewOptionsSelection.MultiSelect and GridOptionsSelection.MultiSelectMode options.

For Grid Views and their descendants the DeleteSelectedRows method affects both the selected data rows and group rows. In Card Views, this method deletes the selected cards. To get references to the selected rows, use the ColumnView.GetSelectedRows method. To get selected cells (in multiple cell selection mode) use the GridView.GetSelectedCells method.

To delete a specific row use the ColumnView.DeleteRow method.

Note

If the DeleteSelectedRows method is called for a master row, only this row is removed. The detail clone view’s records remain untouched.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the DeleteSelectedRows member must not be invoked for these Views. The DeleteSelectedRows member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

The code sample below illustrates how to delete the selected row(s) when a user presses Delete.

C#

gridControl1.ProcessGridKey += GridControl1_ProcessGridKey;

private void GridControl1_ProcessGridKey(object sender, KeyEventArgs e)
{
    var grid = sender as GridControl;
    var view = grid.FocusedView as GridView;
    if (e.KeyData == Keys.Delete)
    {
        view.DeleteSelectedRows();
        e.Handled = true;
    }
}

VB.NET

Private gridControl1.ProcessGridKey += AddressOf GridControl1_ProcessGridKey

Private Sub GridControl1_ProcessGridKey(ByVal sender As Object, ByVal e As KeyEventArgs)
    Dim grid = TryCast(sender, GridControl)
    Dim view = TryCast(grid.FocusedView, GridView)
    If e.KeyData = Keys.Delete Then
        view.DeleteSelectedRows()
        e.Handled = True
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DeleteSelectedRows() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XPO_how-to-view-persistent-objects-in-the-xtragrid-and-edit-them-in-a-separate-window-e771/CS/FormViewOrders.cs#L39

if(MessageBox.Show("Delete selected order?", "Confirm deletion", MessageBoxButtons.YesNo) == DialogResult.Yes) {
    gridView1.DeleteSelectedRows();
    if(unitOfWork1.InTransaction)

how-to-delete-grid-rows-via-a-navigators-custom-button-in-edit-mode-e329/CS/WindowsApplication1/Form1.cs#L49

if (e.Button.ButtonType == NavigatorButtonType.Custom && view!=null) {
    view.DeleteSelectedRows();
}

how-to-implement-simple-copy-paste-operations-in-the-gridview-from-a-toolbar-menu-e4528/CS/DXGridCRUDoperations/Main.cs#L193

{
    gridView1.DeleteSelectedRows();
}

VB.NET

XPO_how-to-view-persistent-objects-in-the-xtragrid-and-edit-them-in-a-separate-window-e771/VB/FormViewOrders.vb#L47

If MessageBox.Show("Delete selected order?", "Confirm deletion", MessageBoxButtons.YesNo) = System.Windows.Forms.DialogResult.Yes Then
    gridView1.DeleteSelectedRows()
    If unitOfWork1.InTransaction Then

how-to-delete-grid-rows-via-a-navigators-custom-button-in-edit-mode-e329/VB/WindowsApplication1/Form1.vb#L51

If e.Button.ButtonType = NavigatorButtonType.Custom AndAlso view IsNot Nothing Then
    view.DeleteSelectedRows()
End If

how-to-implement-simple-copy-paste-operations-in-the-gridview-from-a-toolbar-menu-e4528/VB/DXGridCRUDoperations/Main.vb#L152

If gridView1.IsMultiSelect AndAlso gridView1.SelectedRowsCount > 0 Then
    gridView1.DeleteSelectedRows()
End If