ColumnView.DeleteRow(Int32) Method

Deletes a data record or group row (in Grid Views) from the View. Also removes the corresponding row from a data source.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public virtual void DeleteRow(
    int rowHandle
)

VB.NET

Public Overridable Sub DeleteRow(
    rowHandle As Integer
)

Parameters

Name	Type	Description
rowHandle	Int32	An integer value that is the handle of the row to be deleted.

Remarks

Use this method to delete data and group rows (in Grid Views) and cards (in Card Views). If the rowHandle parameter refers to a group row, the DeleteRow method deletes all data rows that belong to this group. Similarly, if the rowHandle points to a master row, the method removes all related detail rows.

To delete currently selected rows, call the ColumnView.DeleteSelectedRows method.

Since the DeleteRow also removes corresponding data source rows, it is in effect only for data sources that can delete its records. For instance, in DataView sources each row is a DataRow class instances. In this case, the DeleteRow method invokes the Delete() method of the object which represents the row.

Note

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

• 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.

Example

The following code deletes the focused row when the end-user presses the Ctrl+Del shortcut.

To process key press events, we handle the BaseView.KeyDown event. The row is deleted by calling the ColumnView.DeleteRow method.

C#

private void gridView1_KeyDown(object sender, System.Windows.Forms.KeyEventArgs e) {
    if (e.KeyCode == Keys.Delete && e.Modifiers == Keys.Control) {
        if (MessageBox.Show("Delete row?", "Confirmation", MessageBoxButtons.YesNo) != 
          DialogResult.Yes)
            return;
        GridView view = sender as GridView;                
        view.DeleteRow(view.FocusedRowHandle);
    }
}

VB.NET

Private Sub GridView1_KeyDown(ByVal sender As Object, _
  ByVal e As System.Windows.Forms.KeyEventArgs) Handles GridView1.KeyDown
    If (e.KeyCode = Keys.Delete And e.Modifiers = Keys.Control) Then
        If (MessageBox.Show("Delete row?", "Confirmation", _
          MessageBoxButtons.YesNo) <> DialogResult.Yes) Then Return
        Dim view As GridView = CType(sender, GridView)
        view.DeleteRow(view.FocusedRowHandle)
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DeleteRow(Int32) 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#

winforms-grid-show-context-menu-for-rows/CS/FormGridMenu.cs#L33

    GridHitInfo info = GetHitInfo(e.Link);
    info.View.DeleteRow(info.View.FocusedRowHandle);
}

winforms-grid-custom-columns/CS/MyGridHandler.cs#L12

    if(e.KeyData == Keys.Delete && View.State == GridState.Normal)
        View.DeleteRow(View.FocusedRowHandle);
}

winforms-grid-create-gridview-descendant/CS/MyXtraGrid/MyGridHandler.cs#L12

    if(e.KeyData == Keys.Delete && View.State == GridState.Normal)
        View.DeleteRow(View.FocusedRowHandle);
}

VB.NET

winforms-grid-show-context-menu-for-rows/VB/FormGridMenu.vb#L34

    Dim info = GetHitInfo(e.Link)
    info.View.DeleteRow(info.View.FocusedRowHandle)
End Sub

winforms-grid-custom-columns/VB/MyGridHandler.vb#L16

If e.KeyData = Keys.Delete AndAlso View.State = GridState.Normal Then
    View.DeleteRow(View.FocusedRowHandle)
End If

winforms-grid-create-gridview-descendant/VB/MyXtraGrid/MyGridHandler.vb#L16

If e.KeyData = Keys.Delete AndAlso View.State = GridState.Normal Then
    View.DeleteRow(View.FocusedRowHandle)
End If