TextCompositionEventArgs Class

Contains arguments associated with changes to a TextComposition.

System.Object
  System.EventArgs
    System.Windows.RoutedEventArgs
      System.Windows.Input.InputEventArgs
        System.Windows.Input.TextCompositionEventArgs

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

public class TextCompositionEventArgs : InputEventArgs

The TextCompositionEventArgs type exposes the following members.

  NameDescription
Public methodTextCompositionEventArgsInitializes a new instance of the TextCompositionEventArgs class, taking a specified InputDevice and TextComposition as initial values for the class.
Top

  NameDescription
Public propertyControlTextGets control text associated with a TextComposition event.
Public propertyDeviceGets the input device that initiated this event. (Inherited from InputEventArgs.)
Public propertyHandledGets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. (Inherited from RoutedEventArgs.)
Public propertyOriginalSourceGets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. (Inherited from RoutedEventArgs.)
Public propertyRoutedEventGets or sets the RoutedEvent associated with this RoutedEventArgs instance. (Inherited from RoutedEventArgs.)
Public propertySourceGets or sets a reference to the object that raised the event. (Inherited from RoutedEventArgs.)
Public propertySystemTextGets system text associated with a TextComposition event.
Public propertyTextGets input text associated with a TextComposition event.
Public propertyTextCompositionGets the TextComposition associated with a TextComposition event.
Public propertyTimestampGets the time when this event occurred. (Inherited from InputEventArgs.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInvokeEventHandlerInvokes event handlers in a type-specific way, which can increase event system efficiency. (Overrides InputEventArgs.InvokeEventHandler(Delegate, Object).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnSetSourceWhen overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. (Inherited from RoutedEventArgs.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Attached events supported by this delegate include are provided by the TextCompositionManager class, and include TextInput (PreviewTextInput), TextInputStart (PreviewTextInputStart), and TextInputUpdate (PreviewTextInputUpdate).

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft