Undo and Redo in Blazor DocumentEditor Component

27 Jun 20241 minute to read

Blazor Document Editor tracks the history of all editing actions done in the document, which allows undo and redo functionality.

Enable or disable history

Inject the EditorHistory module in your application to provide history preservation functionality for DocumentEditor. Refer to the following code example.

@using Syncfusion.Blazor.DocumentEditor

<SfDocumentEditorContainer @ref="container" EnableToolbar=true>
    <DocumentEditorContainerEvents Created="OnLoad"></DocumentEditorContainerEvents>
</SfDocumentEditorContainer>

@code {
    SfDocumentEditorContainer container;
    protected void OnLoad(object args)
    {
        container.DocumentEditor.EnableEditorHistory = true;
    }
}

You can enable or disable history preservation for a document editor instance any time using the EnableEditorHistory property. Refer to the following sample code.

documentEditor.EnableEditorHistory = true;

Undo and redo

You can perform undo and redo by using CTRL+Z and CTRL+Y keyboard shortcuts. Document editor exposes API to do it programmatically.
To undo the last editing operation in document editor, refer to the following sample code.

await container.DocumentEditor.EditorHistory.UndoAsync();

To redo the last undone action, refer to the following code example.

await container.DocumentEditor.EditorHistory.RedoAsync();

Stack size

History of editing actions will be maintained in stack, so that the last item will be reverted first. By default, document 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.

await container.DocumentEditor.EditorHistory.SetRedoLimitAsync(400);

You can also explore our Blazor Word Processor example to know how to render and configure the document editor.