History in TypeScript DOCX Editor
28 Aug 20261 minute to read
TypeScript DOCX Editor (Document Editor) tracks the history of all editing actions performed in the document, enabling undo and redo functionality.
Enable or disable history
Inject the EditorHistory module in your application to provide history preservation functionality for the DocumentEditor. Refer to the following code example.
//Inject required modules.
DocumentEditor.Inject(Editor, Selection, EditorHistory);
let editor: DocumentEditor = new DocumentEditor({ enableEditor: true, isReadOnly: false });
//Enable editor history module.
editor.enableEditorHistory = true;You can enable or disable history preservation for a DOCX Editor instance at any time using the enableEditorHistory property. Refer to the following sample code.
editor.enableEditorHistory = false;Undo and redo
You can perform undo and redo using the Ctrl + Z and Ctrl + Y keyboard shortcuts. The DOCX Editor exposes an API to do it programmatically.
To undo the last editing operation in the DOCX Editor, refer to the following sample code.
editor.editorHistory.undo();To redo the last undone action, refer to the following code example.
editor.editorHistory.redo();Stack size
History of editing actions will be maintained in a stack, so that the last item will be reverted first. By default, the DOCX Editor limits the size of undo and redo stacks to 500 each, respectively. However, you can customize this limit. Refer to the following sample code.
//Set undo limit.
editor.editorHistory.undoLimit = 400;
//Set redo limit.
editor.editorHistory.redoLimit = 400;