ITfIntegratableCandidateListUIElement::SetIntegrationStyle method (ctffunc.h)

Article
02/22/2024

Sets the integration style.

Syntax

HRESULT SetIntegrationStyle(
  [in] GUID guidIntegrationStyle
);

Parameters

[in] guidIntegrationStyle

The desired type of keyboard integration experience.

Return value

This method can return one of these values.

Value	Description
S_OK	The text service supports the integration style.
E_NOTIMPL	The text service does not support the integration style.

Remarks

If an app needs a keyboard-integrated experience, it can set a GUID for the desired type of integration experience. If the text service supports the integration style, it should return S_OK. If it's not supported, it should return E_NOTIMPL. When called, the text service may adjust its respond to keyboard interaction for the lifetime of the ITfCandidateListUIElement object, for example, until ITfUIElementSink::EndUIElement is called.

Requirements

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