Control.ImeMode Property (System.Windows.Forms)

ImeMode Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

Control..::.ImeMode Property

Gets or sets the Input Method Editor (IME) mode of the control.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic

Public Property ImeMode As ImeMode

public ImeMode ImeMode { get; set; }

Visual C++

public:
property ImeMode ImeMode {
    ImeMode get ();
    void set (ImeMode value);
}

member ImeMode : ImeMode with get, set

Property Value

Type: System.Windows.Forms..::.ImeMode
One of the ImeMode values. The default is Inherit.

Exceptions

Exception	Condition
InvalidEnumArgumentException	The assigned value is not one of the ImeMode enumeration values.

Remarks

An IME is a program that enables users to enter complex characters and symbols, such as Japanese Kanji characters, using a standard keyboard. The ImeMode property is typically set to ImeMode..::.Off for a TextBox control that is intended to only enter numeric values. The ImeMode property value is set to ImeMode..::.NoControl for the Form class.

Most classes that do not directly support Input Method Editors, or allow direct input from an IME, will set the value of this property to NoControl.

Important
The user can interactively change the ImeMode unless it has been programmatically set to ImeMode..::.Disable. In this case, the user will not be able to use the IME.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Control Class

System.Windows.Forms Namespace

ImeMode

DefaultImeMode