InputConnectionWrapper.SetComposingText 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
| Name | Description |
|---|---|
| SetComposingText(ICharSequence, Int32) |
Replace the currently composing text with the given text, and set the new cursor position. |
| SetComposingText(String, Int32) |
Replace the currently composing text with the given text, and set the new cursor position. |
| SetComposingText(ICharSequence, Int32, TextAttribute) |
The variant of setComposingText(CharSequence,int). |
| SetComposingText(String, Int32, TextAttribute) |
The variant of setComposingText(CharSequence,int). |
SetComposingText(ICharSequence, Int32)
Replace the currently composing text with the given text, and set the new cursor position.
[Android.Runtime.Register("setComposingText", "(Ljava/lang/CharSequence;I)Z", "GetSetComposingText_Ljava_lang_CharSequence_IHandler")]
public virtual bool SetComposingText(Java.Lang.ICharSequence? text, int newCursorPosition);[<Android.Runtime.Register("setComposingText", "(Ljava/lang/CharSequence;I)Z", "GetSetComposingText_Ljava_lang_CharSequence_IHandler")>]
abstract member SetComposingText : Java.Lang.ICharSequence * int -> bool
override this.SetComposingText : Java.Lang.ICharSequence * int -> boolParameters
- text
- ICharSequence
The composing text with styles if necessary. If no style object attached to the text, the default style for composing text is used. See ISpanned for how to attach style object to the text. SpannableString and SpannableStringBuilder are two implementations of the interface ISpanned.
- newCursorPosition
- Int32
The new cursor position around the text. 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 you 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.
Returns
true on success, false if the input connection is no longer valid.
Implements
- Attributes
Remarks
Replace the currently composing text with the given text, and set the new cursor position. Any composing text set previously will be removed automatically.
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
SetComposingText(String, Int32)
Replace the currently composing text with the given text, and set the new cursor position.
public bool SetComposingText(string? text, int newCursorPosition);member this.SetComposingText : string * int -> boolParameters
- text
- String
The composing text with styles if necessary. If no style object attached to the text, the default style for composing text is used. See Spanned for how to attach style object to the text. SpannableString and SpannableStringBuilder are two implementations of the interface Spanned.
- newCursorPosition
- Int32
The new cursor position around the text. 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 you 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.
Returns
true on success, false if the input connection is no longer valid.
Remarks
Replace the currently composing text with the given text, and set the new cursor position. Any composing text set previously will be removed automatically.
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
SetComposingText(ICharSequence, Int32, TextAttribute)
The variant of setComposingText(CharSequence,int).
[Android.Runtime.Register("setComposingText", "(Ljava/lang/CharSequence;ILandroid/view/inputmethod/TextAttribute;)Z", "GetSetComposingText_Ljava_lang_CharSequence_ILandroid_view_inputmethod_TextAttribute_Handler", ApiSince=33)]
public virtual bool SetComposingText(Java.Lang.ICharSequence text, int newCursorPosition, Android.Views.InputMethods.TextAttribute? textAttribute);[<Android.Runtime.Register("setComposingText", "(Ljava/lang/CharSequence;ILandroid/view/inputmethod/TextAttribute;)Z", "GetSetComposingText_Ljava_lang_CharSequence_ILandroid_view_inputmethod_TextAttribute_Handler", ApiSince=33)>]
abstract member SetComposingText : Java.Lang.ICharSequence * int * Android.Views.InputMethods.TextAttribute -> bool
override this.SetComposingText : Java.Lang.ICharSequence * int * Android.Views.InputMethods.TextAttribute -> boolParameters
- text
- ICharSequence
- newCursorPosition
- Int32
The new cursor position around the text. 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 you 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
Returns
true on success, false if the input connection is no longer valid.
Implements
- Attributes
Remarks
The variant of setComposingText(CharSequence,int). This method is used to allow the IME to provide extra information while setting up composing text.
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
SetComposingText(String, Int32, TextAttribute)
The variant of setComposingText(CharSequence,int).
public bool SetComposingText(string text, int newCursorPosition, Android.Views.InputMethods.TextAttribute? textAttribute);abstract member SetComposingText : string * int * Android.Views.InputMethods.TextAttribute -> bool
override this.SetComposingText : string * int * Android.Views.InputMethods.TextAttribute -> boolParameters
- text
- String
- newCursorPosition
- Int32
The new cursor position around the text. 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 you 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
Returns
true on success, false if the input connection is no longer valid.
Implements
Remarks
The variant of setComposingText(CharSequence,int). This method is used to allow the IME to provide extra information while setting up composing text.
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.