Vcl.Controls.TWinControl.ResetImeComposition

• Up to Parent: TWinControl

Delphi

function ResetImeComposition(Action: DWORD): Boolean;

C++

bool __fastcall ResetImeComposition(unsigned Action);

Properties

Type	Visibility	Source	Unit	Parent
function	protected	Vcl.Controls.pas Vcl.Controls.hpp	Vcl.Controls	TWinControl

Description

Directs the composition window of the input method editor (IME) to perform a specific action.

Call ResetImeComposition to direct what the composition window does with the input typed by the user. The composition window is the window displayed by the IME that provides feedback to the user about what keystrokes have been typed, and how they are converted into asian characters.

The Action parameter indicates what the composition window should do with its current contents. Action can have one of the following values:

Value	Meaning
CPS_CANCEL	Clear the composition string and set the status to no composition string.
CPS_COMPLETE	Set the composition string as the result string.
CPS_CONVERT	Convert the composition string.
CPS_REVERT	Cancel the current composition string and revert to the unconverted string.

ResetImeComposition returns true if the composition window performs the requested action.

See Also

• ImeMode

• ImeName

• SetImeCompositionWindow