OnKeyboard

This event occurs when a key on the keyboard is pressed or released.

 

JavaScript

 

OnKeyboard(

       Message,

       Char,

       KeyState)

 

C#

 

bool OnKeyboard (

       int Message,

       int Char

       int KeyState)

 

C++

 

HRESULT OnKeyboard (

       [in] long Message,

       [in] long Char,

       [in] long KeyState,

       [out, retval] VARIANT_BOOL pbHandled)

Parameters

Message

The state of the key that is pressed:

·          WM_KEYDOWN = 256

·          WM_KEYUP =257

Char

The virtual key code of the given key. For a list of standard virtual key codes, see https://docs.microsoft.com/en-us/windows/desktop/inputdev/virtual-key-codes.  

 

KeyState

Indicates whether various keys are down. This parameter can be any combination of the following values:

·          LEFT_CONTROL  = 2

·          RIGHT_CONTROL = 4

·          LEFT_SHIFT = 8

·          RIGHT_SHIFT = 16

Return Value

pbHandled

A Boolean that indicates whether or not the client handled the keyboard action itself and does not wish TerraExplorer to respond to the mouse action. When the value is FALSE, TerraExplorer handles the keyboard action.