UIElement.TextInput Event
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.
Occurs when this element gets text in a device-independent manner.
public:
virtual event System::Windows::Input::TextCompositionEventHandler ^ TextInput;public event System.Windows.Input.TextCompositionEventHandler TextInput;member this.TextInput : System.Windows.Input.TextCompositionEventHandler Public Custom Event TextInput As TextCompositionEventHandler Event Type
Implements
Remarks
Important
This event might already be marked as handled by the internal implementations of composited controls. See Remark below.
The TextInput event may already be marked as handled by the internal implementations of composited controls. For example, a TextBox is a composited control where the TextInput event is already marked as handled; within its compositing. Controls do this because the control needs to interpret some types of input, such as arrow keys, as having special meaning to that control. If you use PreviewTextInput as the event where you attach handlers for text input, you may receive better results. This technique circumvents most cases where control composition has already marked this event as handled and prevents your handler from receiving the event along the event route.
The TextInput event allows a component or application to listen for text input in a device-independent manner. The keyboard is the primary means of TextInput, but speech, handwriting, and other input devices can also raise TextInput.
Because of key combinations - either in default keyboards or through input method editors - multiple key events might raise just one text input event.
This event creates an alias for the TextCompositionManager.TextInput attached event for this class, so that TextInput is part of the class members list when UIElement is inherited as a base element. Event handlers that are attached to the TextInput event are attached to the underlying TextCompositionManager.TextInput attached event and receive the same event data instance.
Routed Event Information
| Identifier field | TextInputEvent |
| Routing strategy | Bubbling |
| Delegate | TextCompositionEventHandler |
The corresponding tunneling event is PreviewTextInput.
Override OnTextInput to implement class handling for this event in derived classes.
