Android.Views.InputMethods Namespace

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.

Contains APIs for implementing and interacting with input methods, such as software keyboards.

Classes

Name	Description
BaseInputConnection	Base class for implementors of the InputConnection interface, taking care of most of the common behavior for providing a connection to an Editable.
BaseInputConnection.InterfaceConsts	Exposes input connection interface constants for `BaseInputConnection`.
CompletionInfo	Information about a single text completion that an editor has reported to an input method.
CompletionInfo.InterfaceConsts	Exposes the parcelable interface constants for `CompletionInfo`.
CorrectionInfo	Information about a single text correction that an editor has reported to an input method.
CorrectionInfo.InterfaceConsts	Exposes the parcelable interface constants for `CorrectionInfo`.
CursorAnchorInfo	Positional information about the text insertion point and characters in the composition string.
CursorAnchorInfo.Builder	Builder for `CursorAnchorInfo`.
CursorAnchorInfo.InterfaceConsts	Exposes the parcelable interface constants for `CursorAnchorInfo`.
DeleteGesture	A sub-class of `HandwritingGesture` for deleting an area of text using single rectangle.
DeleteGesture.Builder	Builder for `DeleteGesture`.
DeleteGesture.InterfaceConsts	Exposes the parcelable interface constants for `DeleteGesture`.
DeleteRangeGesture	A subclass of `HandwritingGesture` for deleting a range of text by defining start and end rectangles.
DeleteRangeGesture.Builder	Builder for `DeleteRangeGesture`.
DeleteRangeGesture.InterfaceConsts	Exposes the parcelable interface constants for `DeleteRangeGesture`.
EditorBoundsInfo	Container of rectangular position related info for the Editor.
EditorBoundsInfo.Builder	Builder for `EditorBoundsInfo`.
EditorBoundsInfo.InterfaceConsts	Exposes the parcelable interface constants for `EditorBoundsInfo`.
EditorInfo	An EditorInfo describes several attributes of a text editing object that an input method is communicating with (typically an EditText), most importantly the type of text content it contains and the current cursor position.
EditorInfo.InterfaceConsts	Exposes constants from the interfaces implemented by `EditorInfo`.
ExtractedText	Information about text that has been extracted for use by an input method.
ExtractedText.InterfaceConsts	Exposes the parcelable interface constants for `ExtractedText`.
ExtractedTextRequest	Description of what an input method would like from an application when extract text from its input editor.
ExtractedTextRequest.InterfaceConsts	Exposes the parcelable interface constants for `ExtractedTextRequest`.
HandwritingGesture	Base class for stylus handwriting gestures.
IConnectionlessHandwritingCallbackExtensions	Provides a string overload for the handwriting result callback.
IInputConnectionExtensions	Provides string overloads for input connection methods.
InlineSuggestion	This class represents an inline suggestion which is made by one app and can be embedded into the UI of another.
InlineSuggestion.InterfaceConsts	Exposes the parcelable interface constants for `InlineSuggestion`.
InlineSuggestionInfo	This class represents the description of an inline suggestion.
InlineSuggestionInfo.InterfaceConsts	Exposes the parcelable interface constants for `InlineSuggestionInfo`.
InlineSuggestionsRequest	This class represents an inline suggestion request made by one app to get suggestions from the other source.
InlineSuggestionsRequest.Builder	A builder for `InlineSuggestionsRequest`
InlineSuggestionsRequest.InterfaceConsts	Exposes the parcelable interface constants for `InlineSuggestionsRequest`.
InlineSuggestionsResponse	This class represents an inline suggestion response.
InlineSuggestionsResponse.InterfaceConsts	Exposes the parcelable interface constants for `InlineSuggestionsResponse`.
InputBinding	Information given to an `InputMethod` about a client connecting to it.
InputBinding.InterfaceConsts	Exposes the parcelable interface constants for `InputBinding`.
InputConnection	The InputConnection interface is the communication channel from an InputMethod back to the application that is receiving its input.
InputConnectionWrapper	Wrapper class for proxying calls to another InputConnection.
InputConnectionWrapper.InterfaceConsts	Exposes input connection interface constants for `InputConnectionWrapper`.
InputContentInfo	A container object with which input methods can send content files to the target application.
InputContentInfo.InterfaceConsts	Exposes the parcelable interface constants for `InputContentInfo`.
InputMethod	Provides the legacy binding for input method service constants.
InputMethodInfo	This class is used to specify meta information of an input method.
InputMethodInfo.InterfaceConsts	Exposes the parcelable interface constants for `InputMethodInfo`.
InputMethodManager	Central system API to the overall input method framework (IMF) architecture, which arbitrates interaction between applications and the current input method.
InputMethodSubtype	This class is used to specify meta information of a subtype contained in an input method editor (IME).
InputMethodSubtype.InputMethodSubtypeBuilder	InputMethodSubtypeBuilder is a builder class of InputMethodSubtype.
InputMethodSubtype.InterfaceConsts	Exposes the parcelable interface constants for `InputMethodSubtype`.
InsertGesture	A sub-class of `HandwritingGesture` for inserting text at the defined insertion point.
InsertGesture.Builder	Builder for `InsertGesture`.
InsertGesture.InterfaceConsts	Exposes the parcelable interface constants for `InsertGesture`.
InsertModeGesture	A sub-class of `HandwritingGesture` for starting an insert mode which inserts a space in the editor to let users hand write freely at the designated insertion point.
InsertModeGesture.Builder	Builder for `InsertModeGesture`.
InsertModeGesture.InterfaceConsts	Exposes the parcelable interface constants for `InsertModeGesture`.
JoinOrSplitGesture	A subclass of `HandwritingGesture` for deleting or inserting whitespace in text.
JoinOrSplitGesture.Builder	Builder for `JoinOrSplitGesture`.
JoinOrSplitGesture.InterfaceConsts	Exposes the parcelable interface constants for `JoinOrSplitGesture`.
PreviewableHandwritingGesture	A `HandwritingGesture` that can be `InputConnection#previewHandwritingGesture( PreviewableHandwritingGesture, CancellationSignal) previewed`.
RemoveSpaceGesture	A subclass of `HandwritingGesture` for removing whitespace from text.
RemoveSpaceGesture.Builder	Builder for `RemoveSpaceGesture`.
RemoveSpaceGesture.InterfaceConsts	Exposes the parcelable interface constants for `RemoveSpaceGesture`.
SelectGesture	A sub-class of `HandwritingGesture` for selecting an area of text using single rectangle.
SelectGesture.Builder	Builder for `SelectGesture`.
SelectGesture.InterfaceConsts	Exposes the parcelable interface constants for `SelectGesture`.
SelectRangeGesture	A subclass of `HandwritingGesture` for selecting a range of text by defining start and end rectangles.
SelectRangeGesture.Builder	Builder for `SelectRangeGesture`.
SelectRangeGesture.InterfaceConsts	Exposes the parcelable interface constants for `SelectRangeGesture`.
SurroundingText	Information about the surrounding text around the cursor for use by an input method.
SurroundingText.InterfaceConsts	Exposes the parcelable interface constants for `SurroundingText`.
TextAppearanceInfo	Information about text appearance in an editor, passed through `CursorAnchorInfo` for use by `InputMethodService`.
TextAppearanceInfo.Builder	Builder for `TextAppearanceInfo`.
TextAppearanceInfo.InterfaceConsts	Exposes the parcelable interface constants for `TextAppearanceInfo`.
TextAttribute	The data class that IME can take extra information to applications when setting the text.
TextAttribute.Builder	Builder for creating a `TextAttribute`.
TextAttribute.InterfaceConsts	Exposes the parcelable interface constants for `TextAttribute`.
TextBoundsInfo	The text bounds information of a slice of text in the editor.
TextBoundsInfo.Builder	The builder class to create a `TextBoundsInfo` object.
TextBoundsInfo.InterfaceConsts	Exposes the parcelable interface constants for `TextBoundsInfo`.
TextBoundsInfoResult	The object that holds the result of the `InputConnection#requestTextBoundsInfo(RectF, Executor, Consumer)` call.
TextSnapshot	An immutable data snapshot of text editing state.

Interfaces

Name	Description
IConnectionlessHandwritingCallback	Interface to receive the result of starting a connectionless stylus handwriting session using one of `InputMethodManager#startConnectionlessStylusHandwriting(View, CursorAnchorInfo, Executor,ConnectionlessHandwritingCallback)`, `InputMethodManager#startConnectionlessStylusHandwritingForDelegation(View, CursorAnchorInfo, Executor, ConnectionlessHandwritingCallback)`, or `InputMethodManager#startConnectionlessStylusHandwritingForDelegation(View, CursorAnchorInfo, String, Executor, ConnectionlessHandwritingCallback)`.
IInputConnection	The InputConnection interface is the communication channel from an `InputMethod` back to the application that is receiving its input.
IInputMethod	The InputMethod interface represents an input method which can generate key events and text, such as digital, email addresses, CJK characters, other language characters, and etc.
IInputMethodSession	The InputMethodSession interface provides the per-client functionality of `InputMethod` that is safe to expose to applications.
IInputMethodSessionCallback	Receives the result of creating an input method session.
IInputMethodSessionEventCallback	Receives completion information for an input event sent to an input method session.

Enums

Name	Description
ConnectionlessHandwritingError	Identifies an error reported by a connectionless handwriting session.
CursorAnchorFlags	Describes visibility and direction information for cursor anchor bounds.
CursorUpdate	Enumerates values returned by the Immediate, and Monitor members.
CursorUpdateFilter	Selects the data included in cursor anchor updates.
ExtractedTextFlags	Enumerates values returned by the Flags, Selecting, and SingleLine members.
GetTextFlags	Specifies options for retrieving text from an input connection.
HandwritingDelegateFlag	Specifies options for accepting stylus handwriting delegation.
HandwritingGestureGranularity	Specifies the text unit used by a handwriting selection or deletion gesture.
HandwritingGestureResult	Identifies the reported outcome of a handwriting gesture.
HideSoftInputFlags	Enumerates values returned by the ImplicitOnly, None, and NotAlways members and taken as a parameter of several types.
ImeAction	Enumerates values returned by several types and taken as a parameter of several types.
ImeFlags	Enumerates values returned by several types.
InputContentFlags	Specifies options for committing content through an input connection.
InputMethodResults	Enumerates values returned by several methods of InputMethodResults.
ShowFlags	Enumerates values returned by several types and taken as a parameter of several types.
ShowSoftInputFlags	Enumerates values returned by the Explicit, Forced, and None members and taken as a parameter of several types.
TextBoundsInfoFlags	Describes character properties and line direction in text bounds information.
TextBoundsInfoResultCode	Identifies the outcome of a text bounds information request.
TextExtractFlags	Enumerates values returned by several types.

Remarks

Input connections exchange editing requests and text state between an editor and an input method.