IInputConnection.SetImeConsumesInput(Boolean) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Called by the input method to indicate that it consumes all input for itself, or no longer does so.
[Android.Runtime.Register("setImeConsumesInput", "(Z)Z", "GetSetImeConsumesInput_ZHandler:Android.Views.InputMethods.IInputConnection, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=31)]
public virtual bool SetImeConsumesInput (bool imeConsumesInput);[<Android.Runtime.Register("setImeConsumesInput", "(Z)Z", "GetSetImeConsumesInput_ZHandler:Android.Views.InputMethods.IInputConnection, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=31)>]
abstract member SetImeConsumesInput : bool -> bool
override this.SetImeConsumesInput : bool -> boolParameters
- imeConsumesInput
- Boolean
true when the IME is consuming input and the cursor should be
hidden, false when input to the editor resumes and the cursor should be shown again.
Returns
For editor authors, the return value will always be ignored. For IME authors, this
method returns true if the request was sent (whether or not the associated
editor does something based on this request), false if the input connection
is no longer valid.
- Attributes
Remarks
Called by the input method to indicate that it consumes all input for itself, or no longer does so.
Editors should reflect that they are not receiving input by hiding the cursor if imeConsumesInput is true, and resume showing the cursor if it is false.
Java documentation for android.view.inputmethod.InputConnection.setImeConsumesInput(boolean).
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.