Share via


InputMethodService.OnKeyDown(Keycode, KeyEvent) Method

Definition

Called back when a KeyEvent is forwarded from the target application.

[Android.Runtime.Register("onKeyDown", "(ILandroid/view/KeyEvent;)Z", "GetOnKeyDown_ILandroid_view_KeyEvent_Handler")]
public override bool OnKeyDown (Android.Views.Keycode keyCode, Android.Views.KeyEvent? e);
[<Android.Runtime.Register("onKeyDown", "(ILandroid/view/KeyEvent;)Z", "GetOnKeyDown_ILandroid_view_KeyEvent_Handler")>]
override this.OnKeyDown : Android.Views.Keycode * Android.Views.KeyEvent -> bool

Parameters

keyCode
Keycode

The value in event.getKeyCode()

Returns

true if the event is consumed by the IME and the application no longer needs to consume it. Return false when the event should be handled as if the IME had not seen the event at all.

Attributes

Remarks

Called back when a KeyEvent is forwarded from the target application.

The default implementation intercepts KeyEvent#KEYCODE_BACK if the IME is currently shown , to possibly hide it when the key goes up (if not canceled or long pressed). In addition, in fullscreen mode only, it will consume DPAD movement events to move the cursor in the extracted text view, not allowing them to perform navigation in the underlying application.

The default implementation does not take flags specified to #setBackDisposition(int) into account, even on API version android.os.Build.VERSION_CODES#P and later devices. IME developers are responsible for making sure that their special handling for KeyEvent#KEYCODE_BACK are consistent with the flag they specified to #setBackDisposition(int).

Java documentation for android.inputmethodservice.InputMethodService.onKeyDown(int, android.view.KeyEvent).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to