ITfIntegratableCandidateListUIElement interface (ctffunc.h)

Enables text services and Input Method Editors (IMEs) to adjust UI-less mode behavior.

Inheritance

The ITfIntegratableCandidateListUIElement interface inherits from the IUnknown interface. ITfIntegratableCandidateListUIElement also has these types of members:

Methods

The ITfIntegratableCandidateListUIElement interface has these methods.

 
ITfIntegratableCandidateListUIElement::FinalizeExactCompositionString

Finalizes the current composition with the value currently shown to the user.
ITfIntegratableCandidateListUIElement::GetSelectionStyle

Retrieves the selection style.
ITfIntegratableCandidateListUIElement::OnKeyDown

Processes a key press.
ITfIntegratableCandidateListUIElement::SetIntegrationStyle

Sets the integration style.
ITfIntegratableCandidateListUIElement::ShowCandidateNumbers

Specifies whether candidate numbers should be shown.

Remarks

The ITfIntegratableCandidateListUIElement interface is implemented by text services and Input Method Editors (IMEs) to adjust UI-less mode behavior for a better UI and keyboarding experience in IME-integrated controls, like the Windows 8 Search box. The interface is used by apps that need a more streamlined UI and keyboarding experience with IME languages.

You can get an ITfIntegratableCandidateListUIElement interface pointer by calling QueryInterface on the ITfUIElement interface pointer that's provided by using the dwUIElementId parameters of the ITfUIElementSink callback functions to obtain the interface from ITfUIElementMgr.

The ITfIntegratableCandidateListUIElement interface is an optional interface that's implemented by a text service or IME that needs greater control over how its UI is presented in UI-less mode. Apps can use it to implement more streamlined, special-purpose input controls, as in auto-complete or search suggestions.

Implement the ITfIntegratableCandidateListUIElement interface in the same class that implements the ITfUIElement, ITfCandidateListUIElement, and ITfCandidateListUIElementBehavior interfaces. These interfaces work together to create a fully integrated experience in which the app renders candidate list UI for the text service or IME and can also have some IME-specific UI customization and keyboard interaction behavior.

Requirements

   
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header ctffunc.h

See also

ITfCandidateListUIElement

ITfCandidateListUIElementBehavior

ITfUIElement

ITfUIElementMgr

ITfUIElementSink

IUnknown