ITextStoreAnchorSink::OnLayoutChange method (textstor.h)

The ITextStoreAnchorSink::OnLayoutChange method is 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 ITextStoreAnchor::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 ITextStoreAnchor::GetTextExt or ITextStoreAnchor::GetAnchorFromPoint returns TS_E_NOLAYOUT because the application has not calculated the layout, the application must call ITextStoreAnchorSink::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

See also

ITextStoreAnchor::GetActiveView

ITextStoreAnchor::GetAnchorFromPoint

ITextStoreAnchor::GetTextExt

ITextStoreAnchorSink

TsLayoutCode