ITextStoreACPSink::OnLayoutChange method (textstor.h)

Article
02/22/2024

Called when the layout (on-screen representation) of the document changes.

Syntax

HRESULT OnLayoutChange(
  [in] TsLayoutCode lcode,
  [in] TsViewCookie vcView
);

Parameters

[in] lcode

Contains a TsLayoutCode value that defines the type of change.

[in] vcView

Contains an application-defined cookie that identifies the document. For more information, see ITextStoreACP::GetActiveView.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.

Remarks

A layout change can be in response to a change to the text, font size, window movement, window resizing, or other change that affects the displayed text.

If a call to ITextStoreACP::GetTextExt or ITextStoreACP::GetACPFromPoint returns TS_E_NOLAYOUT because the application has not calculated the layout, the application must call ITextStoreACPSink::OnLayoutChange when the layout is available.

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	textstor.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional