This document is archived and information here might be outdated.  Recommended version.


ISymbologyControlEvents.OnKeyDown Event (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Controls)  

ISymbologyControlEvents.OnKeyDown Event

Fires after a key is pressed on the keyboard.

[Visual Basic .NET]
Public Event OnKeyDown As OnKeyDownEventHandler
[C#]
public event OnKeyDownEventHandler OnKeyDown
[C++]
HRESULT OnKeyDown(
  long keyCode,
  long shift
);
[C++]

Parameters keyCode [in] keyCode is a parameter of type long shift [in] shift is a parameter of type long

Product Availability

Available with ArcGIS Engine.

Description

The OnKeyDown event is triggered when the user presses a key whilst the SymbologyControl has focus.

keyCode specifies a virtual key code value of the key pressed on the keyboard. For alpha-numeric keys this corresponds to the ASCII value, for example "A" key returns 65 which is the ASCII value for capital A. Other key codes are F1 to F12 are 112 to 123 respectively.

Shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.

Remarks

Some development environments will filter out keystrokes. Typically the arrow keys are used to change control focus and will not fire the OnKeyDown event. To intercept these keys use the KeyIntercept property.

See Also

ISymbologyControlEvents Interface