This interface is a means to bracket several IUndoUnits, that is a collection of units that are treated as one (for example they are always undone or redone as a single unit).
Remarks
ICompoundEdits have two states: active and settled. Whenever an ICompoundEdit is retrieved from the UndoEngine or the graph instance, it automatically is active. While an edit is in the active state, it gathers IUndoUnits until the commit or cancel methods are called. Calling the commit method commits all gathered IUndoUnits to the UndoEngine, while canceling will dispose them. Calling either method will put the edit in the settled state. In this state, the edit does not gather units anymore and is not reusable.
ICompoundEdits can also be nested, in this case the changes of the inner edit are not committed directly to the UndoEngine but to the outer edit. Only when the outer edit is committed, the units are committed to the UndoEngine.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.ICompoundEdit
See Also
Methods
This method cancels the compound editing process.
Remarks
See Also
This method commits the compound editing process.