DataGridView Events


.NET Framework Class Library
DataGridView..::.UserDeletingRow Event

Occurs when the user deletes a row from the DataGridView control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
Syntax

Visual Basic (Declaration)
Public Event UserDeletingRow As DataGridViewRowCancelEventHandler
Visual Basic (Usage)
Dim instance As DataGridView
Dim handler As DataGridViewRowCancelEventHandler

AddHandler instance.UserDeletingRow, handler
C#
public event DataGridViewRowCancelEventHandler UserDeletingRow
Visual C++
public:
 event DataGridViewRowCancelEventHandler^ UserDeletingRow {
    void add (DataGridViewRowCancelEventHandler^ value);
    void remove (DataGridViewRowCancelEventHandler^ value);
}
JScript
JScript does not support events.
Remarks

This event can be canceled to prevent a row deletion from being completed.

For more information about handling events, see Consuming Events.

Examples

The following code example demonstrates how to use the UserDeletingRow event to cancel the deletion of rows from the DataGridView if the starting balance row is included in the selection. This example is part of a larger example available in the SelectionChanged event.

Visual Basic
Private Sub UserDeletingRow(ByVal sender As Object, _
    ByVal e As DataGridViewRowCancelEventArgs) _
    Handles DataGridView1.UserDeletingRow

    Dim startingBalanceRow As DataGridViewRow = DataGridView1.Rows(0)

    ' Check if the starting balance row is included in the selected rows
    If DataGridView1.SelectedRows.Contains(startingBalanceRow) Then

        If e.Row.Equals(startingBalanceRow) Then

            ' Do not allow the user to delete the Starting Balance row.
            MessageBox.Show("Cannot delete Starting Balance row!")
        End If

        ' Cancel the deletion if the Starting Balance row is included.
        e.Cancel = True

    End If

End Sub
C#
private void DataGridView1_UserDeletingRow(object sender,
    DataGridViewRowCancelEventArgs e)
{
    DataGridViewRow startingBalanceRow = DataGridView1.Rows[0];

    // Check if the Starting Balance row is included in the selected rows
    if (DataGridView1.SelectedRows.Contains(startingBalanceRow))
    {
        // Do not allow the user to delete the Starting Balance row.
        if (e.Row.Equals(startingBalanceRow))
        {
            MessageBox.Show("Cannot delete Starting Balance row!");
        }

        // Cancel the deletion if the Starting Balance row is included.
        e.Cancel = true;
    }
}
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Other Resources

Tags :


Page view tracker