Help Center

CRichEdit.SetIMEOptionsmethod

Sets the Input Method Editor (IME) options.

Windowsmethoddocumented

Syntax

FUNCTION SetIMEOptions (BYVAL hRichEdit AS HWND, BYVAL fCoop AS LONG, BYVAL fOptions AS LONG) AS LONG

Parameters

NameDescription
hRichEditThe handle of the rich edit control.
fCoopSpecifies one of the following values.
ECOOP_SET. Sets the options to those specified by fOptions.
COOP_OR. Combines the specified options with the current options.
ECOOP_AND. Retains only those current options that are also specified by fOptions.
ECOOP_XOR. Logically exclusive OR the current options with those specified by fOptions.
fOptionsSpecifies one of more of the following values.
IMF_CLOSESTATUSWINDOW. Closes the IME status window when the control receives the input focus.
IMF_FORCEACTIVE. Activates the IME when the control receives the input focus.
IMF_FORCEDISABLE. Disables the IME when the control receives the input focus.
IMF_FORCEENABLE. Enables the IME when the control receives the input focus.
IMF_FORCEINACTIVE. Inactivates the IME when the control receives the input focus.
IMF_FORCENONE. Disables IME handling.
IMF_FORCEREMEMBER. Restores the previous IME status when the control receives the input focus.
IMF_MULTIPLEEDIT. Specifies that the composition string will not be canceled or determined by focus changes. This allows an application to have separate composition strings on each rich edit control.
IMF_VERTICAL. Note: used in Rich Edit 2.0 and later.

Return value

If the operation succeeds, the return value is a nonzero value.

If the operation fails, the return value is zero.

Description

Sets the Input Method Editor (IME) options.

Reference

  • Defined in AfxNova/CRichEdit.inc:1050
  • Documented in Windows/WIndows Controls/CRichEdit Class.md
  • Topic: CRichEdit Class