This documentation is archived and is not being maintained.

DataGridView.ProcessDeleteKey Method

Note: This method is new in the .NET Framework version 2.0.

Processes the DELETE key.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

protected bool ProcessDeleteKey (
	Keys keyData
)
protected boolean ProcessDeleteKey (
	Keys keyData
)
protected function ProcessDeleteKey (
	keyData : Keys
) : boolean

Parameters

keyData

A bitwise combination of Keys values that represents the key or keys to process.

Return Value

true if the key was processed; otherwise, false.

Exception typeCondition

Exception

The DELETE key would delete one or more rows, but an error in the data source prevents the deletion and either there is no handler for the DataError event or the handler has set the DataGridViewDataErrorEventArgs.ThrowException property to true.

This method returns true when the user presses DELETE to delete rows in the control. The user can delete rows if the SelectionMode property is set to FullRowSelect or RowHeaderSelect and the MultiSelect property is set to true. If the DataGridView is bound to data, the IBindingList.AllowRemove property of the data source must also be set to true.

Notes to Inheritors Override this method to customize row deletion. When overriding this method, a control should return true to indicate that it has processed the key. For keys that are not processed by the control, return the result of the base version of this method.

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: