Share via


InputMethodService.SendDefaultEditorAction(Boolean) Method

Definition

Ask the input target to execute its default action via InputConnection#performEditorAction InputConnection.performEditorAction().

[Android.Runtime.Register("sendDefaultEditorAction", "(Z)Z", "GetSendDefaultEditorAction_ZHandler")]
public virtual bool SendDefaultEditorAction (bool fromEnterKey);
[<Android.Runtime.Register("sendDefaultEditorAction", "(Z)Z", "GetSendDefaultEditorAction_ZHandler")>]
abstract member SendDefaultEditorAction : bool -> bool
override this.SendDefaultEditorAction : bool -> bool

Parameters

fromEnterKey
Boolean

If true, this will be executed as if the user had pressed an enter key on the keyboard, that is it will <em>not</em> be done if the editor has set EditorInfo#IME_FLAG_NO_ENTER_ACTION EditorInfo.IME_FLAG_NO_ENTER_ACTION. If false, the action will be sent regardless of how the editor has set that flag.

Returns

Returns a boolean indicating whether an action has been sent. If false, either the editor did not specify a default action or it does not want an action from the enter key. If true, the action was sent (or there was no input connection at all).

Attributes

Remarks

Ask the input target to execute its default action via InputConnection#performEditorAction InputConnection.performEditorAction().

For compatibility, this method does not execute a custom action even if EditorInfo#actionLabel EditorInfo.actionLabel is set. The implementor should directly call InputConnection#performEditorAction InputConnection.performEditorAction() with EditorInfo#actionId EditorInfo.actionId if they want to execute a custom action.

Java documentation for android.inputmethodservice.InputMethodService.sendDefaultEditorAction(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.

Applies to