Edit

IMEMode property

  • Article

Specifies the default run time mode of the Input Method Editor (IME) for a control. This property applies only to applications written for East Asia and is ignored in other applications.

Syntax

object.IMEMode [= fmIMEMode ]

The IMEMode property syntax has these parts:

Part Description
object Required. A valid object.
fmIMEMode Optional. The mode of the Input Method Editor (IME).

Settings

The settings for fmIMEMode are:

Constant Value Description
fmIMEModeNoControl 0 Does not control IME (default).
fmIMEModeOn 1 IME on.
fmIMEModeOff 2 IME off. English mode.
fmIMEModeDisable 3 IME off. User can't turn on IME by keyboard.
fmIMEModeHiragana 4 IME on with Full-width Hiragana mode.
fmIMEModeKatakana 5 IME on with Full-width Katakana mode.
fmIMEModeKatakanaHalf 6 IME on with Half-width Katakana mode.
fmIMEModeAlphaFull 7 IME on with Full-width Alphanumeric mode.
fmIMEModeAlpha 8 IME on with Half-width Alphanumeric mode.
fmIMEModeHangulFull 9 IME on with Full-width Hangul mode.
fmIMEModeHangul 10 IME on with Half-width Hangul mode.

The fmIMEModeNoControl setting indicates that the mode of the IME does not change when the control receives focus at run time. For any other value, the mode of the IME is set to the value specified by the IMEMode property when the control receives focus at run time.

Remarks

There are two ways to set the mode of the IME. One is through the toolbar of the IME. The other is with the IMEMode property of a control, which sets or returns the current mode of the IME. This property allows dynamic control of the IME through code.

The following example explains how IMEMode interacts with the toolbar of the IME. Assume that you have designed a form with TextBox1 and CheckBox1. You have set TextBox1.IMEMode to 0, and you have set CheckBox1.IMEMode to 1. While in design mode, you have used the IME toolbar to put the IME in mode 2.

When you run the form, the IME begins in mode 2. If you click TextBox1, the IME mode does not change because IMEMode for this control is 0. If you click CheckBox1, the IME changes to mode 1, because IMEMode for this control is 1. If you click again on TextBox1, the IME remains in mode 1 (IMEMode is 0, so the IME retains its last setting).

However, you can override IMEMode. For example, assume you click CheckBox1 and the IME enters mode 1, as defined by IMEMode for the CheckBox. If you then use the IME toolbar to put the IME in mode 3, the IME will be set to mode 3 anytime you click the control. This does not change the value of the property; it overrides the property until the next time you run the form.

See also

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.