OnKeyboardMessage

This event occurs when the user presses a keyboard key.

 

JavaScript
OnKeyboardMessage(        Message,        KeyCode,        KeyData,        pbHandled)

 

C#
void OnKeyboardMessage(        int Message,        int KeyCode,        int KeyData,        ref object pbHandled)

 

C++
HRESULT OnKeyboardMessage(        long Message,        long KeyCode,        long KeyData,        VARIANT* pbHandled)

Parameters:

Message

Specify the window message id. See: MSDN Library on each value. This parameter can have one of the following values:

·         WM_KEYDOWN = 256

·         WM_KEYUP = 257

·         WM_CHAR = 258

·         WM_DEADCHAR = 259

·         WM_SYSKEYDOWN = 260

·         WM_SYSKEYUP = 261

·         WM_SYSCHAR = 262

·         WM_SYSDEADCHAR = 263

KeyCode

Specifies the virtual-key code of the non-system key. See: MSDN Library (e.g., WM_KEYUP).

KeyData

Specifies the repeat count, scan code, extended-key flag, context code, previous key-state flag, and transition-state flag, as shown in the following table. See: MSDN Library (e.g., WM_KEYUP)

pbHandled

Setting this to TRUE informs TerraExplorer that the client handled the keyboard message itself and does not wish TerraExplorer to respond to the mouse action. When the client sets this to FALSE, TerraExplorer handles the keyboard action normally.