CIMEShare Interface

Article
05/05/2014

Describes the CIMEShare interface of Microsoft Input Method Editor (IME) 2003, Japanese version. The CIMEShare interface provides a Input Method Editor Reference that allows clients to receive common display attributes for Microsoft IME, allowing an application to share the same behavior and interface as other IMEShare client applications.

Note: CIMEShare Interface is not supported by Office 2007. This content is kept here to help developers for previous versions of Office.

CIMEShare Members

Method	Description
CIMEShare::CustomizeIMEShare Method	Opens the control panel.
CIMEShare::DwGetIMEStyle Method	Gets various style settings given as idsty for given attr.
CIMEShare::DwGetIMEStyleCpl Method	Gets various style settings given as idsty for given attribute.
CIMEShare::FDeleteIMEShare Method	Releases the CIMEShare interface.
CIMEShare::FSaveIMEShareCpl Method	Saves the style settings to registry.
CIMEShare::FSetIMEStyleCpl Method	Changes the style setting.
CIMEShare::FSupportSty Method	Defines style substitutions.
CIMEShare::LidSetLid Method	Sets current LID.
CIMEShare::LidGetLid Method	Gets current LID.
CIMEShare::PIMEShareCreate Method	Creates a CIMEShare object and returns a pointer to the object. This is an exported DLL function.

Value Definitions

IME States

Possible values include:

IMESATTR_INPUT
IMESATTR_TARGET_CONVERTED
IMESATTR_CONVERTED
IMESATTR_TARGET_NOTCONVERTED
IMESATTR_INPUT_ERROR
IMESATTR_FIXEDCONVERTED

Underline Styles

Possible values include:

IMESTY_UL_NONE
IMESTY_UL_SINGLE
IMESTY_UL_DOTTED
IMESTY_UL_THICK
IMESTY_UL_THICKDITHLOWER
IMESTY_UL_DITHLOWER

Idsty tokens and corresponding values

Token	Value Type	Comment
IdstyIMEShareFBold	BOOL	TRUE if it has bold style
IdstyIMEShareFItalic	BOOL	TRUE if it has italic style
IdstyIMEShareFUl	BOOL	TRUE if it is underlined
IdstyIMEShareUKul	UINT	Type of underline; will be ignored when IdstyIMEShareFUl is FALSE
IdstyIMEShareFWinCol*	BOOL	TRUE if color for text is in Windows color definition
IdstyIMEShareFFundCol*	BOOL	TRUE if color is in fundamental color definition
IdstyIMEShareFRGBCol*	BOOL	TRUE if color is in RGB color definition
IdstyIMEShareFSpecCol*	BOOL	TRUE if color is in special color definition
IdstyIMEShareRGBCol*	COLORREF	Current color setting in RGB

*Needs to specify subproperty ID (one of following):

Subproperty ID	Description
IdstyIMEShareSubText	Color for text
IdstyIMEShareSubBack	Color for background
IdstyIMEShareSubUl	Color for underline

Creating CIMEShare Instance

CIMEShare::PIMEShareCreate Method

General Functions

Getting Style Attributes

LID Management

IMEShare uses LID to store attribute settings for each language separately. IMEShare can get the default LID by itself, but the client can change it.

Special Functions for the Control Panel

These methods are provided only for use by control panel for IME. Ordinary clients should not use them.