CoreTextTextUpdatingEventArgs Class

  • Reference

Definition

Namespace:
Windows.UI.Text.Core
Edit

Provides data for the TextUpdating event.

public ref class CoreTextTextUpdatingEventArgs sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class CoreTextTextUpdatingEventArgs final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class CoreTextTextUpdatingEventArgs
Public NotInheritable Class CoreTextTextUpdatingEventArgs
Inheritance
Object Platform::Object IInspectable CoreTextTextUpdatingEventArgs
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

An object of this type is passed as an argument to a handler for the TextUpdating event.

Properties

InputLanguage

Gets a Language object representing the current input language.
IsCanceled

Gets a value that indicates whether the text update operation is canceled.
NewSelection

Gets a value that indicates the range of text that the text input server indicates should be selected. The server populates this property before raising the event.
Range

Gets a value that indicates the range of text that the text input server needs to modify. The server populates this property before raising the event.
Result

Gets or sets a value that indicates the result of handling the TextUpdating event. The default value is Succeeded but if you can't action the operation as the text input server expects then before returning from the event handler set the property to the appropriate value to indicate what has happened.
Text

Gets the text that the text input server is requesting to be set into the modified range. The server populates this property before raising the event.

Methods

GetDeferral()

Requests that the text update operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

Applies to