Using Undo and Redo

You can use Ctrl + Z to undo an action in the widget. You can then use Ctrl + Y to redo the action you canceled.

You can undo the following types of actions:

Editing text
Autofit when double-clicking
Resizing headers
Dragging columns or rows with the mouse
Expanding or collapsing groups with the group button
Editing the sheet tab name by double-clicking on the tab strip
Using Ctrl + V to paste
Using the Commands class to execute an action
Context menu operations executed in the viewport area.

The following actions do not respond to Ctrl + Z:

Sorting or filtering with the drop-down button
Selecting a range
Navigating to a specific cell
Scrolling
Resizing the tab strip resize box
Clicking the new tab option on the tab strip
Context menu operations executed in the sheet tab area.
Invoking the fromJSON() method of the Workbook or fromJSON() method of the Worksheet in the execute() method of the CommandManager class.
Invoking the Undo method and the Redo method of the UndoManager class in the execute() method of the CommandManager class.

You can prevent or allow the undo action in code with the options.allowUndo property.

After setting the allowUndo property to true, you can undo or redo an action by using the startTransaction() method, undoTransaction() method and the endTransaction() method.

Using Code

This example sets the options.allowUndo property and specifies an action.

JavaScript	Copy Code
spread.options.allowUndo = true; spread.commandManager().execute({cmd: "outlineRow", sheetName: activeSheet.name(), index: 3, count: 5});

This example changes the background color of a cell using the startTransaction() method, undoTransaction() method and the endTransaction() method.

JavaScript	Copy Code
var command = { canUndo: true, execute: function (context, options, isUndo) { var Commands = GC.Spread.Sheets.Commands; if (isUndo) { Commands.undoTransaction(context, options); return true; } else { Commands.startTransaction(context, options); var sheet = context.getSheetFromName(options.sheetName); var cell = sheet.getCell(options.row, options.col); cell.backColor(options.backColor); Commands.endTransaction(context, options); return true; } } }; var spread = GC.Spread.Sheets.findControl(document.getElementById("sampleDiv")); var commandManager = spread.commandManager(); commandManager.register("changeBackColor", command); commandManager.execute({ cmd: "changeBackColor", sheetName: spread.getSheet(0).name(), row: 1, col: 2, backColor: "red" });

JavaScript

Copy Code

var command = { canUndo: true, execute: function (context, options, isUndo)

{ var Commands = GC.Spread.Sheets.Commands;
if (isUndo)

                  {
                     Commands.undoTransaction(context, options);
                     return true;
                  }

else

                  {
                    Commands.startTransaction(context, options);
                    var sheet = context.getSheetFromName(options.sheetName);
                    var cell = sheet.getCell(options.row, options.col);
                    cell.backColor(options.backColor);
                    Commands.endTransaction(context, options);
                    return true;
                   }

}
};
var spread = GC.Spread.Sheets.findControl(document.getElementById("sampleDiv"));
var commandManager = spread.commandManager();
commandManager.register("changeBackColor", command);
commandManager.execute({ cmd: "changeBackColor", sheetName: spread.getSheet(0).name(), row: 1, col: 2, backColor: "red" });