IVsIME Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

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.

public interface class IVsIME

public interface class IVsIME

__interface IVsIME

[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("DC7EDE19-3DD1-4E20-A7F1-110883ED996F")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsIME

[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("DC7EDE19-3DD1-4E20-A7F1-110883ED996F")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsIME = interface

Public Interface IVsIME

Attributes

ComConversionLossAttribute GuidAttribute InterfaceTypeAttribute

Remarks

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

Methods

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