ITextDocument::BeginEditCollection method (tom.h)

Turns on edit collection (also called undo grouping).

Syntax

HRESULT BeginEditCollection();

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return code Description
S_FALSE
Undo is not enabled.
E_NOTIMPL
This method is not implemented.

Remarks

A single Undo command undoes all changes made while edit collection is turned on.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

Conceptual

EndEditCollection

Freeze

ITextDocument

Reference

Text Object Model