ProcessDataGridViewKey Method
TOC
Collapse the table of content
Expand the table of content

DataGridView.ProcessDataGridViewKey Method (KeyEventArgs)

 

Processes keys used for navigating in the DataGridView.

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

[<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
abstract ProcessDataGridViewKey : 
        e:KeyEventArgs -> bool
[<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
override ProcessDataGridViewKey : 
        e:KeyEventArgs -> bool

Parameters

e
Type: System.Windows.Forms.KeyEventArgs

Contains information about the key that was pressed.

Return Value

Type: System.Boolean

true if the key was processed; otherwise, false.

Exception Condition
InvalidCastException

The key pressed would cause the control to enter edit mode, but the EditType property of the current cell does not indicate a class that derives from Control and implements IDataGridViewEditingControl.

Exception

This action would commit a cell value or enter edit mode, but an error in the data source prevents the action and either there is no handler for the DataError event or the handler has set the DataGridViewDataErrorEventArgs.ThrowException property to true.

-or-

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 calls the key-processing method appropriate to the key pressed (for example, the ProcessF2Key method when F2 is pressed) and returns the return value of that method.

Notes to Inheritors:

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.

The following code example demonstrates how to change the behavior of the ENTER key in a DataGridView subclass by overriding the ProcessDataGridViewKey and ProcessDialogKey methods. In the example, the ENTER key has the same behavior as the RIGHT ARROW key, making it easier for a user to edit multiple cells in a single row of data.

No code example is currently available or this language may not be supported.

SecurityPermission

for calling unmanaged code. Demand value: LinkDemand. Permission value: UnmanagedCode

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft