ImeTextComposition Class

Represents a text composition generated by the IME processing of the ITextView.

Inheritance Hierarchy

Object
  DispatcherObject
    TextComposition
      Microsoft.VisualStudio.Text.Editor.ImeTextComposition

Namespace:  Microsoft.VisualStudio.Text.Editor
Assembly:  Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)

Syntax

'Declaration
Public Class ImeTextComposition _
    Inherits TextComposition
public class ImeTextComposition : TextComposition
public ref class ImeTextComposition : public TextComposition
type ImeTextComposition =  
    class 
        inherit TextComposition 
    end
public class ImeTextComposition extends TextComposition

The ImeTextComposition type exposes the following members.

Constructors

  Name Description
Public method ImeTextComposition Initializes a new instance of ImeTextComposition.

Top

Properties

  Name Description
Public property AutoComplete Gets the auto-complete setting for this text composition. (Inherited from TextComposition.)
Public property CompositionText Gets or sets the composition text for this text composition. (Inherited from TextComposition.)
Public property ControlText Gets or sets any control text associated with this text composition. (Inherited from TextComposition.)
Public property Dispatcher Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property SystemCompositionText Gets or sets the system composition text for this text composition. (Inherited from TextComposition.)
Public property SystemText Gets or sets the system text for this text composition. (Inherited from TextComposition.)
Public property Text Gets or sets the current text for this text composition. (Inherited from TextComposition.)

Top

Methods

  Name Description
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method Complete Security Critical. Completes this text composition. (Inherited from TextComposition.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)

Top

Remarks

The ITextView does its own handling and raises the appropriate TextComposition events. The TextComposition property of all events raised by the IME handling can be cast to ImeTextComposition.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Text.Editor Namespace