DataGrid REALbasic Plugin

DataGrid.KeyDown Event

This event is fired when a keyboard key is hit when the Grid has the focus.

KeyDown(
   charCode as Integer,
   keyCode as Integer,
   modifiers as Integer) as Boolean

Parameters

charCode
The charCode of the pressed key.
keyCode
The keyCode of the pressed key.
modifiers
Integer value representing pressed modifiers.

Returns

Boolean
The return value will determine if the control parent window will get the KeyDown event or not. (The return value will not cancel internal handling, see notes bellow)

false = the event is forwarded to the parent window.
(That is the control will say, no I didn't handle this event, so the window gets it)

true = the event is forwarded to the parent window)
(That is the control will say, yes I did handle this event, so the event ends its lifetime here)

Remarks

If you want to intercept the keydown event that is not let the Grid get it internally then set the CancelEventAction property to true.

Up, Down, Left and Right keys will never be routed to the control parent window, except when CancelEventAction has been used, and false returned.

See Also

DataGrid Control