If a user wants to perform an undo/redo command, use the startTransaction method. In the following code, the custom command changes will be saved:
To end a transaction, use the endTransaction method. In the following code, the custom command changes will be saved:
If a user wants to undo the transaction, use the undoTransaction method. In the following code, the command changes will be undone:
import * as React from 'react';
import { createRoot } from 'react-dom/client';
import './styles.css';
import { AppFunc } from './app-func';
import { App } from './app-class';
// 1. Functional Component sample
createRoot(document.getElementById('app')).render(<AppFunc />);
// 2. Class Component sample
// createRoot(document.getElementById('app')).render(<App />);
import * as React from 'react';
import { SpreadSheets, Worksheet } from '@mescius/spread-sheets-react';
import GC from '@mescius/spread-sheets';
const useState = React.useState;
export function AppFunc() {
const [spread, setSpread] = useState(null);
const initSpread = (spread) => {
setSpread(spread);
}
const undo = () => {
let undoManager = spread.undoManager();
undoManager.undo();
}
const redo = () => {
let undoManager = spread.undoManager();
undoManager.redo();
}
const setBackColor = () => {
let sheet = spread.getActiveSheet();
let command = {
canUndo: true,
execute: function (spread, options, isUndo) {
let Commands = GC.Spread.Sheets.Commands;
if (isUndo) {
Commands.undoTransaction(spread, options);
return true;
} else {
Commands.startTransaction(spread, options);
spread.suspendPaint();
let selections = options.selections;
let value = options.backColor;
selections.forEach(function (sel) {
sheet.getRange(sel.row, sel.col, sel.rowCount, sel.colCount).backColor(value);
});
spread.resumePaint();
Commands.endTransaction(spread, options);
return true;
}
}
};
let selections = sheet.getSelections();
let commandManager = spread.commandManager();
commandManager.register('changeBackColor', command);
commandManager.execute({
cmd: 'changeBackColor',
sheetName: spread.getSheet(0).name(),
selections: selections,
backColor: 'rgb(130, 188, 0)'
});
}
return (
<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => initSpread(spread)}>
<Worksheet>
</Worksheet>
</SpreadSheets>
</div>
<Panel
undo={() => undo()}
redo={() => redo()}
setBackColor={() => setBackColor()}
></Panel>
</div>
);
}
function Panel(props) {
return (
<div class="options-container">
<div className="option-row">
<label>Please select a range and click 'Set BackColor' button will set backColor for the range, and
click 'Undo' button and 'Redo' button will undo and redo the set backColor action.</label>
</div>
<div className="option-row">
<input type="button" value="Set BackColor" onClick={props.setBackColor} />
</div>
<div className="option-row">
<input type="button" value="Undo" onClick={props.undo} />
</div>
<div className="option-row">
<input type="button" value="Redo" onClick={props.redo} />
</div>
<hr />
<div className="option-row">
<label>Use the keyboard shortcuts 'Ctrl-Z' to undo the custom action, and use the keyBoard shortcuts
'Ctrl-Y' to redo the custom action.</label>
</div>
</div>
);
}
import * as React from 'react';
import { SpreadSheets, Worksheet } from '@mescius/spread-sheets-react';
import GC from '@mescius/spread-sheets';
const Component = React.Component;
export class App extends Component {
constructor(props) {
super(props);
this.spread = null;
}
render() {
return (
<div class="sample-tutorial">
<div class="sample-spreadsheets">
<SpreadSheets workbookInitialized={spread => this.initSpread(spread)}>
<Worksheet>
</Worksheet>
</SpreadSheets>
</div>
<Panel
undo={() => this.undo()}
redo={() => this.redo()}
setBackColor={() => this.setBackColor()}
></Panel>
</div>
);
}
initSpread(spread) {
this.spread = spread;
}
undo() {
let spread = this.spread;
let undoManager = spread.undoManager();
undoManager.undo();
}
redo() {
let spread = this.spread;
let undoManager = spread.undoManager();
undoManager.redo();
}
setBackColor() {
let spread = this.spread;
let sheet = spread.getActiveSheet();
let command = {
canUndo: true,
execute: function (spread, options, isUndo) {
let Commands = GC.Spread.Sheets.Commands;
if (isUndo) {
Commands.undoTransaction(spread, options);
return true;
} else {
Commands.startTransaction(spread, options);
spread.suspendPaint();
let selections = options.selections;
let value = options.backColor;
selections.forEach(function (sel) {
sheet.getRange(sel.row, sel.col, sel.rowCount, sel.colCount).backColor(value);
});
spread.resumePaint();
Commands.endTransaction(spread, options);
return true;
}
}
};
let selections = sheet.getSelections();
let commandManager = spread.commandManager();
commandManager.register('changeBackColor', command);
commandManager.execute({
cmd: 'changeBackColor',
sheetName: spread.getSheet(0).name(),
selections: selections,
backColor: 'rgb(130, 188, 0)'
});
}
}
function Panel(props) {
return (
<div class="options-container">
<div className="option-row">
<label>Please select a range and click 'Set BackColor' button will set backColor for the range, and
click 'Undo' button and 'Redo' button will undo and redo the set backColor action.</label>
</div>
<div className="option-row">
<input type="button" value="Set BackColor" onClick={props.setBackColor} />
</div>
<div className="option-row">
<input type="button" value="Undo" onClick={props.undo} />
</div>
<div className="option-row">
<input type="button" value="Redo" onClick={props.redo} />
</div>
<hr />
<div className="option-row">
<label>Use the keyboard shortcuts 'Ctrl-Z' to undo the custom action, and use the keyBoard shortcuts
'Ctrl-Y' to redo the custom action.</label>
</div>
</div>
);
}
<!doctype html>
<html style="height:100%;font-size:14px;">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css" href="$DEMOROOT$/en/react/node_modules/@mescius/spread-sheets/styles/gc.spread.sheets.excel2013white.css">
<!-- SystemJS -->
<script src="$DEMOROOT$/en/react/node_modules/systemjs/dist/system.src.js"></script>
<script src="systemjs.config.js"></script>
<script>
System.import('$DEMOROOT$/en/lib/react/license.js').then(function () {
System.import('./src/app');
});
</script>
</head>
<body>
<div id="app"></div>
</body>
</html>
.sample-tutorial {
position: relative;
height: 100%;
overflow: hidden;
}
.sample-spreadsheets {
width: calc(100% - 280px);
height: 100%;
overflow: hidden;
float: left;
}
.options-container {
float: right;
width: 280px;
padding: 12px;
height: 100%;
box-sizing: border-box;
background: #fbfbfb;
overflow: auto;
}
.option-row {
font-size: 14px;
padding: 5px;
}
label {
display: block;
margin-bottom: 6px;
}
input[type=button] {
margin-top: 6px;
display: block;
}
body {
position: absolute;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
#app {
height: 100%;
}
(function (global) {
System.config({
transpiler: 'plugin-babel',
babelOptions: {
es2015: true,
react: true
},
meta: {
'*.css': { loader: 'css' }
},
paths: {
// paths serve as alias
'npm:': 'node_modules/',
'cdn:': 'https://cdn.mescius.io/demoapps/packages/spreadjs/19.2.4-master-2026-09-29-2130/'
},
// map tells the System loader where to look for things
map: {
'@mescius/spread-sheets': 'cdn:@mescius/spread-sheets/index.js',
'@mescius/spread-sheets-react': 'cdn:@mescius/spread-sheets-react/index.js',
'@grapecity/jsob-test-dependency-package/react-components': 'npm:@grapecity/jsob-test-dependency-package/react-components/index.js',
'react': 'npm:react/cjs/react.production.js',
'react-dom': 'npm:react-dom/cjs/react-dom.production.js',
'react-dom/client': 'npm:react-dom/cjs/react-dom-client.production.js',
'scheduler': 'npm:scheduler/cjs/scheduler.production.js',
'css': 'npm:systemjs-plugin-css/css.js',
'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js',
'systemjs-babel-build':'npm:systemjs-plugin-babel/systemjs-babel-browser.js'
},
// packages tells the System loader how to load when no filename and/or no extension
packages: {
src: {
defaultExtension: 'jsx'
},
"node_modules": {
defaultExtension: 'js'
},
}
});
})(this);
