FrameworkTextComposition Class

Definition

Namespace:

System.Windows.Documents

Assembly:

PresentationFramework.dll

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

public ref class FrameworkTextComposition : System::Windows::Input::TextComposition

public class FrameworkTextComposition : System.Windows.Input.TextComposition

type FrameworkTextComposition = class
    inherit TextComposition

Public Class FrameworkTextComposition
Inherits TextComposition

Inheritance

Object

DispatcherObject

TextComposition

FrameworkTextComposition

Derived

System.Windows.Documents.FrameworkRichTextComposition

Remarks

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.

Properties

AutoComplete	Gets the auto-complete setting for this text composition. (Inherited from TextComposition)
CompositionLength	Gets the length of the current composition in Unicode symbols.
CompositionOffset	Gets the position at which the composition text occurs in the TextBox.
CompositionText	Gets or sets the composition text for this text composition. (Inherited from TextComposition)
ControlText	Gets or sets any control text associated with this text composition. (Inherited from TextComposition)
Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject)
ResultLength	Gets the length of the finalized text in Unicode symbols when the TextInput event occurs.
ResultOffset	Gets the offset of the finalized text when the TextInput event occurs.
SystemCompositionText	Gets or sets the system composition text for this text composition. (Inherited from TextComposition)
SystemText	Gets or sets the system text for this text composition. (Inherited from TextComposition)
Text	Gets or sets the current text for this text composition. (Inherited from TextComposition)

Methods

CheckAccess()	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
Complete()	Finalizes the composition.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)
VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)