InputMethod.AccessibilityInputConnection.CommitText 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.
Overloads
| CommitText(ICharSequence, Int32, TextAttribute) |
Commit text to the text box and set the new cursor position. |
| CommitText(String, Int32, TextAttribute) |
Commit text to the text box and set the new cursor position. |
CommitText(ICharSequence, Int32, TextAttribute)
Commit text to the text box and set the new cursor position.
[Android.Runtime.Register("commitText", "(Ljava/lang/CharSequence;ILandroid/view/inputmethod/TextAttribute;)V", "", ApiSince=33)]
public void CommitText (Java.Lang.ICharSequence text, int newCursorPosition, Android.Views.InputMethods.TextAttribute? textAttribute);[<Android.Runtime.Register("commitText", "(Ljava/lang/CharSequence;ILandroid/view/inputmethod/TextAttribute;)V", "", ApiSince=33)>]
member this.CommitText : Java.Lang.ICharSequence * int * Android.Views.InputMethods.TextAttribute -> unitParameters
- text
- ICharSequence
The text to commit. This may include styles.
- newCursorPosition
- Int32
The new cursor position around the text, in Java characters. If > 0, this is relative to the end of the text - 1; if <= 0, this is relative to the start of the text. So a value of 1 will always advance the cursor to the position after the full text being inserted. Note that this means you can't position the cursor within the text, because the editor can make modifications to the text you are providing so it is not possible to correctly specify locations there.
- textAttribute
- TextAttribute
The extra information about the text.
- Attributes
Remarks
Commit text to the text box and set the new cursor position. This method is used to allow the IME to provide extra information while setting up text.
This method commits the contents of the currently composing text, and then moves the cursor according to newCursorPosition. If there is no composing text when this method is called, the new text is inserted at the cursor position, removing text inside the selection if any.
Calling this method will cause the editor to call #onUpdateSelection(int, int, int, int, int, int) on the current accessibility service after the batch input is over. <strong>Editor authors</strong>, for this to happen you need to make the changes known to the accessibility service by calling InputMethodManager#updateSelection(android.view.View, int, int, int, int), but be careful to wait until the batch edit is over if one is in progress.
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
CommitText(String, Int32, TextAttribute)
Commit text to the text box and set the new cursor position.
public void CommitText (string text, int newCursorPosition, Android.Views.InputMethods.TextAttribute? textAttribute);member this.CommitText : string * int * Android.Views.InputMethods.TextAttribute -> unitParameters
- text
- String
The text to commit. This may include styles.
- newCursorPosition
- Int32
The new cursor position around the text, in Java characters. If > 0, this is relative to the end of the text - 1; if <= 0, this is relative to the start of the text. So a value of 1 will always advance the cursor to the position after the full text being inserted. Note that this means you can't position the cursor within the text, because the editor can make modifications to the text you are providing so it is not possible to correctly specify locations there.
- textAttribute
- TextAttribute
The extra information about the text.
Remarks
Commit text to the text box and set the new cursor position. This method is used to allow the IME to provide extra information while setting up text.
This method commits the contents of the currently composing text, and then moves the cursor according to newCursorPosition. If there is no composing text when this method is called, the new text is inserted at the cursor position, removing text inside the selection if any.
Calling this method will cause the editor to call #onUpdateSelection(int, int, int, int, int, int) on the current accessibility service after the batch input is over. <strong>Editor authors</strong>, for this to happen you need to make the changes known to the accessibility service by calling InputMethodManager#updateSelection(android.view.View, int, int, int, int), but be careful to wait until the batch edit is over if one is in progress.
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.