ITfTextLayoutSink::OnLayoutChange method (msctf.h)

Article
10/13/2021

Receives a notification when the layout of a context view changes.

Syntax

HRESULT OnLayoutChange(
  [in] ITfContext     *pic,
  [in] TfLayoutCode   lcode,
  [in] ITfContextView *pView
);

Parameters

[in] pic

Pointer to the ITfContext interface for the context that changed.

[in] lcode

Specifies the TfLayoutCode element that describes the layout change.

[in] pView

Pointer to the ITfContextView interface for the context view in that the layout change occurred.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Each context has a default view for which a reference can be obtained using the ITfContext::GetActiveView method. The method returns only the value TF_LC_CHANGE for the lcode parameter for this view, because the values are possible only for multiple views. Because TSF does not support multiple views, this method never receives other values of the TfLayoutCode enumeration.

Requirements

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