DataGridView.ProcessDeleteKey(Keys) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Processes the DELETE key.

protected:
 bool ProcessDeleteKey(System::Windows::Forms::Keys keyData);

protected bool ProcessDeleteKey (System.Windows.Forms.Keys keyData);

member this.ProcessDeleteKey : System.Windows.Forms.Keys -> bool

Protected Function ProcessDeleteKey (keyData As Keys) As Boolean

Parameters

keyData: Keys

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

Returns

Boolean

true if the key was processed; otherwise, false.

Exceptions

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 ThrowException property to true.

Remarks

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.

Applies to