UIElement.TextInputUpdate Event

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Occurs when text continues to be composed via an input method editor (IME).

Namespace:  System.Windows
Assembly:  System.Windows (in System.Windows.dll)

Syntax

'Declaration
Public Event TextInputUpdate As TextCompositionEventHandler
public event TextCompositionEventHandler TextInputUpdate
<uiElement TextInputUpdate="eventhandler"/>

Remarks

Use a handler based on TextCompositionEventHandler to handle this event.

The scenario for handling this event from a focused UI element as opposed to handling TextInput is exclusively for processing IME input. Generally, IME is only enabled for text input controls (TextBox specifically, and derived classes).

For TextInputUpdate you are generally interested in the relationship between the TextComposition and Text values in the event data.

This event is a bubbling event. This means that if multiple TextInputUpdate handlers are registered for a sequence of objects connected by parent-child relationships in the object tree, the event is received by each object in that relationship, with the route going in the parent direction. The sender available to the event handler identifies the object where the event is handled, not necessarily the object that actually received the input condition that initiated the event. To get the object that initiated the event, use the OriginalSource value of the event's RoutedEventArgs event data. For more information on routed event concepts, see Events Overview for Silverlight.

IME support in Silverlight also includes attached properties that can influence IME handling and behavior, which can be set on a TextBox. See InputMethod.

TextInputUpdate and OnTextInputUpdate

For control classes (anything that derives from Control) there is potentially an assigned virtual/override handler for this event, as defined by OnTextInputUpdate.

Version Information

Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.