Expand Minimize

DataGridView.ProcessKeyPreview Method

Previews a keyboard message.

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

[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
protected override bool ProcessKeyPreview(
	ref Message m
)

Parameters

m
Type: System.Windows.Forms.Message

A Message, passed by reference, that represents the window message to process.

Return Value

Type: System.Boolean
true if the message was processed; otherwise, false.

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

For more information, see the Control.ProcessKeyPreview method on the base class.

Notes to Inheritors

When overriding this method, a control should return true to indicate that it has processed the message. For messages that are not processed by the control, return the result of the base version of this method.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft