ITfUIElementSink::BeginUIElement method (msctf.h)

The ITfUIElementSink::BeginUIElement method is called when the UIElement started. This sink can let the textservice to draw or not to draw the UI element.

Syntax

HRESULT BeginUIElement(
  [in] DWORD dwUIElementId,
       BOOL  *pbShow
);

Parameters

[in] dwUIElementId

[in] Id of the UIElement that was started.

pbShow

[in, out] Return true if the application does not draw the UIElement content and the text service draws its original UI content. Return false if the application draws the UIElement's content and stops the text service from drawing it. The application can get the ITfUIElement interface by using ITfUIElementMgr::GetUIElement and it can evaluate if it can handle the UIElement by QI with IID_ITfCandidateListUIElement or with other UIElement interfaces. The application can always return FALSE if it is unknown or it cannot be handled. In this case, the text service will not show any extra UI on the screen. This is a good way for some full screen applications. Alternatively, the application can return TRUE to use TextService's UI on some particular or unknown UIs.

Return value

The TSF manager ignores the return value of this method.

Value	Description
S_OK	The method was successful.
E_FAIL	An unspecified error occurred.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps | UWP apps]
Target Platform	Windows
Header	msctf.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional