Share via


InputMethodService.OnStartCandidatesView(EditorInfo, Boolean) Method

Definition

Called when only the candidates view has been shown for showing processing as the user enters text through a hard keyboard.

[Android.Runtime.Register("onStartCandidatesView", "(Landroid/view/inputmethod/EditorInfo;Z)V", "GetOnStartCandidatesView_Landroid_view_inputmethod_EditorInfo_ZHandler")]
public virtual void OnStartCandidatesView (Android.Views.InputMethods.EditorInfo? editorInfo, bool restarting);
[<Android.Runtime.Register("onStartCandidatesView", "(Landroid/view/inputmethod/EditorInfo;Z)V", "GetOnStartCandidatesView_Landroid_view_inputmethod_EditorInfo_ZHandler")>]
abstract member OnStartCandidatesView : Android.Views.InputMethods.EditorInfo * bool -> unit
override this.OnStartCandidatesView : Android.Views.InputMethods.EditorInfo * bool -> unit

Parameters

editorInfo
EditorInfo

Description of the type of text being edited.

restarting
Boolean

Set to true if we are restarting input on the same text field as before.

Attributes

Remarks

Called when only the candidates view has been shown for showing processing as the user enters text through a hard keyboard. This will always be called after #onStartInput, allowing you to do your general setup there and just view-specific setup here. You are guaranteed that #onCreateCandidatesView() will have been called some time before this function is called.

Note that this will <em>not</em> be called when the input method is running in full editing mode, and thus receiving #onStartInputView to initiate that operation. This is only for the case when candidates are being shown while the input method editor is hidden but wants to show its candidates UI as text is entered through some other mechanism.

Java documentation for android.inputmethodservice.InputMethodService.onStartCandidatesView(android.view.inputmethod.EditorInfo, 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