FrameworkTextComposition Class

Represents a composition during the text input events of a TextBox.

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

public class FrameworkTextComposition : TextComposition

The FrameworkTextComposition type exposes the following members.

  NameDescription
Public propertyAutoCompleteGets the auto-complete setting for this text composition. (Inherited from TextComposition.)
Public propertyCompositionLengthGets the length of the current composition in Unicode symbols.
Public propertyCompositionOffsetGets the position at which the composition text occurs in the TextBox.
Public propertyCompositionTextGets or sets the composition text for this text composition. (Inherited from TextComposition.)
Public propertyControlTextGets or sets any control text associated with this text composition. (Inherited from TextComposition.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyResultLengthGets the length of the finalized text in Unicode symbols when the TextInput event occurs.
Public propertyResultOffsetGets the offset of the finalized text when the TextInput event occurs.
Public propertySystemCompositionTextGets or sets the system composition text for this text composition. (Inherited from TextComposition.)
Public propertySystemTextGets or sets the system text for this text composition. (Inherited from TextComposition.)
Public propertyTextGets or sets the current text for this text composition. (Inherited from TextComposition.)
Top

  NameDescription
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodCompleteFinalizes the composition. (Overrides TextComposition.Complete().)
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 methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top

The TextCompositionEventArgs.TextComposition property is a FrameworkTextComposition when the user enters text into a TextBox by using an Input Method Editor (IME) and the TextInput, TextInputUpdate, or TextInputStart event occurs. 

FrameworkTextComposition is the base class of FrameworkRichTextComposition. The FrameworkRichTextComposition class defines properties that return TextPointer objects to indicate the position of the text composition. When the user enters text into a RichTextBox, TextCompositionEventArgs.TextComposition is a FrameworkRichTextComposition.

.NET Framework

Supported in: 4.5.3, 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