IVsIME Interface

Gives the package access to the Input Method Editor (IME). The Input Method Editor offers candidate items in response to user keystrokes. Frequently used in localization for non-alphabetic languages. You can get an instance of the interface from the SVsIME (SID_SVsIME) service.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
<GuidAttribute("DC7EDE19-3DD1-4E20-A7F1-110883ED996F")> _
<InterfaceTypeAttribute()> _
Public Interface IVsIME
[GuidAttribute("DC7EDE19-3DD1-4E20-A7F1-110883ED996F")]
[InterfaceTypeAttribute()]
public interface IVsIME
[GuidAttribute(L"DC7EDE19-3DD1-4E20-A7F1-110883ED996F")]
[InterfaceTypeAttribute()]
public interface class IVsIME
[<GuidAttribute("DC7EDE19-3DD1-4E20-A7F1-110883ED996F")>]
[<InterfaceTypeAttribute()>]
type IVsIME =  interface end
public interface IVsIME

The IVsIME type exposes the following members.

Methods

  Name Description
Public method Activate Activates the Input Method Editor (IME).
Public method AttachContext Associates or disassociates an Input Method Editor (IME) context with an editor window. For more information about IME contexts, see Input Context.
Public method Deactivate Deactivates the Input Method Editor (IME).
Public method Escape Provides access to ImmEscape, a method enabling access to features, often country-specific, of particular Input Method Editors (IME).
Public method FDeactivate Enables or disables the Input Method Editor (IME).
Public method GetDefaultWindow Retrieves the default window for the Input Method Editor (IME) class that is active. Wrapper for a call to ImmGetDefaultIMEWnd.
Public method GetImmCompositionString Retrieves information about the composition string. Wrapper for a call to ImmGetCompositionString.
Public method GetImmCompositionStringW Retrieves information about the composition string. Wrapper for a call to ImmGetCompositionString. Handles string as wide characters (wchar_t) rather than as bytes.
Public method GetImmContext Retrieves the Input Method Editor (IME) context for a given window. Use before getting or setting IME information using methods such as GetImmCompositionString.
Public method IsActive Indicates whether or not the Input Method Editor (IME) is active for a given window.
Public method Notify Notifies the Input Method Editor (IME) of changes to the IME input context. The method is a wrapper for ImmNotifyIME.
Public method ReleaseImmContext Releases the Input Method Editor (IME) input context and frees the associated memory. The method is a wrapper for ImmReleaseContext. You should call this function once for each call to GetImmContext.
Public method SetCurPos Sets the current position of the editing window using the Input Method Editor (IME). The method provides a wrapper to ImmSetCompositionWindow.
Public method SetDefCurPos Moves the editor window to the default position. The method provides a wrapper to ImmSetCompositionWindow.
Public method SetFont Sets the fault in the editor window. Provides a wrapper to ImmSetCompositionFont.
Public method SetImmCandidateWindow Sets aspects of the candidate list window. Provides a wrapper for ImmSetCandidateWindow.
Public method SetImmCompositionString Sets the characters, attributes, and clauses of the composition and reading strings. Provides a wrapper for ImmSetCompositionString.

Top

Remarks

For an example of using the IME in a standalone application, see International Samples in the Visual C++ Samples.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace