ESRI.ArcGIS.ADF
OnKeyDown Method
See Also  Send comments on this topic.
ESRI.ArcGIS.ADF.BaseClasses Namespace > BaseTool Class : OnKeyDown Method




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, Shift would be 5.
This method is called when a key is pressed down, when this tool is active.

Syntax

Visual Basic (Declaration) 
Public Overridable Sub OnKeyDown( _
   ByVal keyCode As Integer, _
   ByVal Shift As Integer _
) 
Visual Basic (Usage)Copy Code
Dim instance As BaseTool
Dim keyCode As Integer
Dim Shift As Integer
 
instance.OnKeyDown(keyCode, Shift)
C# 
public virtual void OnKeyDown( 
   int keyCode,
   int Shift
)

Parameters

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, Shift would be 5.

Remarks

Note to inheritors: Override the OnKeyDown method if you need to perform some action when the OnKeyDown event is raised when the tool is active.

See Also

© 2010 All Rights Reserved.