GC.Spread.Sheets.Commands

Namespace: Commands

Spread.Sheets.Commands

Variables

Functions

Variables

DefineColumn

• DefineColumn: Object

表示用于定义列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property [options.col] 插入的指定列，可选。

property options.column - 定义的列。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用定义列操作。
// 定义列属性
spread.commandManager().execute({cmd: "DefineColumn", sheetName: "Sheet1", { col: 1, column: { value: 'column1' }}});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col?`: `number` ; `column`: `IColumn` ; `sheetName`: `string` }) => `any`

ModifyColumn

• ModifyColumn: Object

表示用于修改列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.col - 指定的列。

property options.column - 修改后的列。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用修改列操作。
// 修改列属性
spread.commandManager().execute({cmd: "ModifyColumn", sheetName: "Sheet1", { col: 1, column: { value: 'column1' }}});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `column`: `IColumn` ; `sheetName`: `string` }) => `any`

RemoveColumn

• RemoveColumn: Object

表示用于删除列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.col - 指定的列。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用删除列操作。
// 删除列属性
spread.commandManager().execute({cmd: "RemoveColumn", sheetName: "Sheet1", { col: 1 }});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `sheetName`: `string` }) => `any`

ReportChartPreviewVisible

• ReportChartPreviewVisible: Object

表示用于更改报表中单元格绑定图表的报表图表预览可见性的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.row - 数据图表行号。

property options.col - 数据图表列号。

property options.visible - 数据图表可见性。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令在设计模式下更改报表中的数据图表预览可见性
spread.commandManager().execute({cmd: "ReportChartPreviewVisible", sheetName: "Report1", row: 1, col: 1, visible: true});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetName`: `string` ; `visible`: `boolean` }, `isUndo`: `boolean`) => `boolean`

ReportCollapseButtonToggle

• ReportCollapseButtonToggle: Object

表示用于切换报表中单个折叠按钮的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.row - 折叠按钮行号。

property options.col - 折叠按钮列号。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令切换单个折叠按钮
spread.commandManager().execute({cmd: "ReportCollapseButtonToggle", sheetName: "Report1", row: 1, col: 1});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

autoFitColumn

• autoFitColumn: Object

表示用于自动调整工作表中列宽的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.columns - 要调整的列；每个项目都是一个包含col属性的对象。

property options.rowHeader - 调整的列是否在行标题区域。

property options.autoFitType - 自动调整操作是否包含标题文本。

property isUndo - 如果是撤销操作则为true；否则为false。

example

var columns = [ { col: 3 } ];
spread.options.allowUndo = true;
spread.commandManager().execute({cmd: "autoFitColumn", sheetName: "Sheet1", columns: columns, rowHeader: false, autoFitType: GC.Spread.Sheets.AutoFitType.cell});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `autoFitType`: `AutoFitType` ; `columns`: `Object`[] ; `rowHeader`: `boolean` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

autoFitRow

• autoFitRow: Object

表示用于自动调整工作表中行高的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.rows - 要调整的行；每个项目都是一个包含row属性的对象。

property options.columnHeader - 调整的行是否在列标题区域。

property options.autoFitType - 自动调整操作是否包含标题文本。

property isUndo - 如果是撤销操作则为true；否则为false。

example

spread.options.allowUndo = true;
var rows = [ { row: 3 } ];
spread.commandManager().execute({cmd: "autoFitRow", sheetName: "Sheet1", rows: rows, columnHeader: false, autoFitType: GC.Spread.Sheets.AutoFitType.cell});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `autoFitType`: `AutoFitType` ; `columnHeader`: `boolean` ; `rows`: `Object`[] ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

cancelInput

• cancelInput: Object

表示用于停止单元格编辑并取消输入的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令停止单元格编辑
// 此示例将在2秒后取消输入编辑器
activeSheet.setValue(0, 0, '12312');
activeSheet.startEdit();
window.setTimeout(function() {
    spread.commandManager().execute({ cmd: "cancelInput", sheetName: "Sheet1" });
}, 2000);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

changeEditorStatus

• changeEditorStatus: Object

表示用于在单元格编辑时切换编辑器状态（输入模式和编辑模式之间）的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令开始编辑单元格
spread.commandManager().execute({cmd: "changeEditorStatus", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

changeFormulaReference

• changeFormulaReference: Object

表示用于在编辑公式时切换公式引用（相对、绝对和混合引用之间）的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用changeFormulaReference操作来切换公式引用。
spread.commandManager().execute({cmd: "changeFormulaReference", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

clear

• clear: Object

表示用于清除单元格值的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 使用Tab键清除选中的单元格
spread.commandManager().setShortcutKey('clear', GC.Spread.Commands.Key.tab, false, false, false, false); // Tab键

// 通过调用命令清除选中的单元格
spread.commandManager().execute({cmd: "clear", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

clearAndEditing

• clearAndEditing: Object

表示用于清除活动单元格值并进入编辑模式的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令清除活动单元格并进入编辑模式
spread.commandManager().execute({cmd: "clearAndEditing", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

clearValues

• clearValues: Object

表示用于清除工作表中单元格值的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.ranges - 要清除的单元格值范围数组，其项类型为GC.Spread.Sheets.Range。

property isUndo - 如果是撤销操作则为true；否则为false。

example

spread.options.allowUndo = true;
spread.commandManager().execute({cmd: "clearValues", sheetName: "Sheet1", ranges: [new GC.Spread.Sheets.Range(8, 5, 2, 1)]});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `ranges`: `Range`[] ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

clipboardPaste

• clipboardPaste: Object

表示用于在工作表上执行剪贴板粘贴的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.fromSheet - 源工作表。

property options.fromRanges - 源范围数组，其项类型为GC.Spread.Sheets.Range。

property options.pastedRanges - 目标范围数组，其项类型为GC.Spread.Sheets.Range。

property options.isCutting - 操作是剪切还是复制。

property options.clipboardText - 剪贴板上的文本。

property options.pasteOption - 剪贴板粘贴选项，指示要粘贴的内容。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用clipboardPaste方法。
activeSheet.setValue(0, 0, 1, GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setValue(1, 0, 2, GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setFormula(2, 0, "=A1+A2", GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setValue(0, 1, 3, GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setValue(1, 1, 4, GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setFormula(2, 1, "=B1+B2", GC.Spread.Sheets.SheetArea.viewport);
var fromRange = [new GC.Spread.Sheets.Range(0, 0, 3, 2)];
var toRanges = [new GC.Spread.Sheets.Range(5, 0, 3, 2)];
$("#button1").click(function () {
    //剪切粘贴操作
    spread.commandManager().execute({cmd: "clipboardPaste", sheetName: "Sheet1", fromSheet: activeSheet, fromRanges: fromRange, pastedRanges: toRanges, isCutting: true, clipboardText: "", pasteOption: GC.Spread.Sheets.ClipboardPasteOptions.all});
});
$("#button2").click(function () {
    spread.commandManager().execute({cmd: "clipboardPaste", sheetName: "Sheet1", fromSheet: activeSheet, fromRanges: fromRange, pastedRanges: toRanges, isCutting: false, clipboardText: "", pasteOption: GC.Spread.Sheets.ClipboardPasteOptions.all});
});
//添加按钮控件到页面
&lt;input type="button" id="button1" value="button1"/&gt;
&lt;input type="button" id="button2" value="button2"/&gt;

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `clipboardText`: `string` ; `fromRanges`: `Range`[] ; `fromSheet`: `Worksheet` ; `isCutting`: `boolean` ; `pasteOption`: `ClipboardPasteOptions` ; `pastedRanges`: `Range`[] ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

commitArrayFormula

• commitArrayFormula: Object

表示用于提交单元格编辑并将数组公式设置到活动范围的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令提交单元格编辑并将数组公式设置到活动范围
spread.commandManager().execute({cmd: "commitArrayFormula", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

commitInputNavigationDown

• commitInputNavigationDown: Object

表示用于停止单元格编辑并将活动单元格移动到下一行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令停止单元格编辑并将活动单元格移动到下一行
activeSheet.setValue(1, 1, '12312');
activeSheet.setActiveCell(1,1);
activeSheet.startEdit();
window.setTimeout(function() {
    spread.commandManager().execute({cmd: "commitInputNavigationDown", sheetName: "Sheet1"});
}, 1000);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

commitInputNavigationUp

• commitInputNavigationUp: Object

表示用于停止单元格编辑并将活动单元格移动到上一行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令停止单元格编辑并将活动单元格移动到上一行
activeSheet.setValue(1, 1, 'SpreadJS');
activeSheet.setActiveCell(1,1);
activeSheet.startEdit();
window.setTimeout(function() {
    spread.commandManager().execute({cmd: "commitInputNavigationUp", sheetName: "Sheet1"});
}, 1000);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

copy

• copy: Object

表示用于将选中项文本复制到剪贴板的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令将选中项文本复制到剪贴板
spread.commandManager().execute({cmd: "copy", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

copySheet

• copySheet: Object

表示用于复制工作表的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 克隆的工作表名称。

property options.targetIndex - 目标索引。

property options.newName - 新工作表名称。

property options.includeBindingSource - 是否将数据源绑定到克隆的工作表。

example

// 此示例复制一个工作表。
spread.commandManager().execute({cmd: "copySheet", sheetName: "Sheet1", targetIndex: targetIndex, newName: "Sheet1 (2)", includeBindingSource: true});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `includeBindingSource`: `boolean` ; `newName`: `string` ; `sheetName`: `string` ; `targetIndex`: `number` }) => `void`

cut

• cut: Object

表示用于将选中项文本剪切到剪贴板的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令将选中项文本剪切到剪贴板
spread.commandManager().execute({cmd: "cut", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

deleteFloatingObjects

• deleteFloatingObjects: Object

表示用于删除浮动对象的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令删除浮动对象
spread.commandManager().execute({cmd: "deleteFloatingObjects", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

dragCopyFloatingObjects

• dragCopyFloatingObjects: Object

表示用于在工作表上拖拽复制浮动对象的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.floatingObjects - 浮动对象的名称数组。

property options.offsetX - 水平偏移量。

property options.offsetY - 垂直偏移量。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令复制浮动对象
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("floatingObject1", 10, 10, 60, 64);
var div = document.createElement('div');
div.innerHTML = '<span> SpreadJS支持浮动对象。</span>'+
'<div style="border: 1px dotted  gray; width: 60%; height:70%; margin:auto;">' +
'<ul><li>第一个列表</li></ul><ul><li>第二个列表</li></ul></div>';
customFloatingObject.content(div);
activeSheet.floatingObjects.add(customFloatingObject);
spread.commandManager().execute({cmd: "dragCopyFloatingObjects", sheetName: "Sheet1", floatingObjects: ["floatingObject1"], offsetX: 100, offsetY: 200});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `floatingObjects`: `string`[] ; `offsetX`: `number` ; `offsetY`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

dragDrop

• dragDrop: Object

表示用于在工作表上拖拽一个区域并放置到另一个区域的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property commandOptions - 操作的选项。

property commandOptions.sheetName - 工作表名称。

property commandOptions.fromRow - 拖拽的源行索引。

property commandOptions.fromColumn - 拖拽的源列索引。

property commandOptions.toRow - 拖拽的目标行索引。

property commandOptions.toColumn - 拖拽的目标列索引。

property commandOptions.rowCount - 拖拽的行数。

property commandOptions.columnCount - 拖拽的列数。

property commandOptions.copy - 如果设置为true则复制；否则如果为false则剪切。

property commandOptions.insert - 如果设置为true则在放置行或列中插入拖拽数据。

property commandOptions.option - 指示要拖拽放置的内容类型。

property isUndo - 如果是撤销操作则为true；否则为false。

example

spread.options.allowUndo = true;
spread.commandManager().execute({cmd: "dragDrop",  sheetName: "Sheet1", fromRow:2, fromColumn:1, toRow:12, toColumn:2, rowCount:2, columnCount:2, copy: true, insert: false, option: GC.Spread.Sheets.CopyToOptions.value});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `columnCount`: `number` ; `copy`: `boolean` ; `fromColumn`: `number` ; `fromRow`: `number` ; `insert`: `boolean` ; `option`: `CopyToOptions` ; `rowCount`: `number` ; `sheetName`: `string` ; `toColumn`: `number` ; `toRow`: `number` }, `isUndo`: `boolean`) => `boolean`

editCell

• editCell: Object

表示用于在工作表的单元格上应用新值的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.row - 单元格的行索引。

property options.col - 单元格的列索引。

property options.newValue - 单元格的新值。

property options.autoFormat - 是否自动格式化新值。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令为单元格应用新值
spread.commandManager().execute({cmd: "editCell", sheetName: "Sheet1", row: 1, col: 1, newValue: "123", autoFormat: true});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `autoFormat`: `boolean` ; `col`: `number` ; `newValue`: `any` ; `row`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

expandColumnOutline

• expandColumnOutline: Object

表示用于展开或折叠列范围组的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.index - 大纲摘要索引。

property options.level - 大纲级别。

property options.collapsed - 是否使大纲折叠或展开。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令折叠列范围组
spread.commandManager().execute({cmd: "expandColumnOutline", sheetName: "Sheet1", index: 5, level: 0, collapsed: true});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `collapsed`: `boolean` ; `index`: `number` ; `level`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

expandColumnOutlineForLevel

• expandColumnOutlineForLevel: Object

表示用于展开或折叠同一级别的列范围组的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.level - 大纲级别。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令展开或折叠列范围组
spread.commandManager().execute({cmd: "expandColumnOutlineForLevel", sheetName: "Sheet1", level: 0});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `level`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

expandRowOutline

• expandRowOutline: Object

表示用于展开或折叠行范围组的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.index - 大纲摘要索引。

property options.level - 大纲级别。

property options.collapsed - 是否使大纲折叠或展开。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令展开行范围组
spread.commandManager().execute({cmd: "expandRowOutline", sheetName: "Sheet1", index: 5, level: 0, collapsed: false});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `collapsed`: `boolean` ; `index`: `number` ; `level`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

expandRowOutlineForLevel

• expandRowOutlineForLevel: Object

表示用于展开或折叠同一级别的行范围组的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.level - 大纲级别。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令展开或折叠行范围组
spread.commandManager().execute({cmd: "expandRowOutlineForLevel", sheetName: "Sheet1", level: 0});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `level`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

fill

• fill: Object

表示用于在工作表上拖拽填充范围的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.startRange - 起始范围。

property options.fillRange - 填充范围。

property options.autoFillType - 自动填充类型。

property options.fillDirection - 填充方向。

property isUndo - 如果是撤销操作则为true；否则为false。

example

spread.options.allowUndo = true;
var srange = new GC.Spread.Sheets.Range(10, 5, 1, 1);
var frange = new GC.Spread.Sheets.Range(11, 5, 5, 1);
spread.commandManager().execute({cmd: "fill", sheetName: "Sheet1", startRange: srange, fillRange: frange, autoFillType: GC.Spread.Sheets.Fill.AutoFillType.fillSeries, fillDirection: GC.Spread.Sheets.Fill.FillDirection.down });

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `autoFillType`: `AutoFillType` ; `fillDirection`: `FillDirection` ; `fillRange`: `Range` ; `sheetName`: `string` ; `startRange`: `Range` }, `isUndo`: `boolean`) => `boolean`

moveFloatingObjects

• moveFloatingObjects: Object

表示用于移动浮动对象的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.floatingObjects - 浮动对象的名称数组。

property options.offsetX - 水平偏移量。

property options.offsetY - 垂直偏移量。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令移动浮动对象
spread.commandManager().execute({cmd: "moveFloatingObjects", sheetName: "Sheet1", floatingObjects: ["floatingObject1", "floatingObject2"], offsetX: 10, offsetY: 20});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `floatingObjects`: `string`[] ; `offsetX`: `number` ; `offsetY`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

moveSheet

• moveSheet: Object

表示用于移动工作表的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.targetIndex - 目标索引。

example

//此示例移动一个工作表。
spread.commandManager().execute({cmd: "moveSheet", sheetName: "Sheet1", targetIndex: targetIndex});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` ; `targetIndex`: `number` }) => `boolean`

moveToNextCell

• moveToNextCell: Object

表示用于将活动单元格移动到下一个单元格的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例映射moveToNextCell动作。
spread.focus();
spread.commandManager().setShortcutKey('moveToNextCell', GC.Spread.Commands.Key.a, false, false, false, false); // a

// 通过调用命令将活动单元格移动到下一个单元格
spread.commandManager().execute({cmd: "moveToNextCell", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

moveToNextCellThenControl

• moveToNextCellThenControl: Object

表示用于在活动单元格是最后一个可见单元格时选择下一个控件；否则将活动单元格移动到下一个单元格的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例映射moveToNextCellThenControl动作。
spread.commandManager().setShortcutKey('moveToNextCellThenControl', GC.Spread.Commands.Key.tab, false, false, false, false); // Tab键
spread.commandManager().setShortcutKey('moveToPreviousCellThenControl', GC.Spread.Commands.Key.tab, false, true, false, false); // Shift键和Tab键

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

moveToPreviousCell

• moveToPreviousCell: Object

表示用于将活动单元格移动到上一个单元格的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用moveToPreviousCell动作。
spread.commandManager().setShortcutKey('moveToPreviousCell', GC.Spread.Commands.Key.a, false, false, false, false); // a键

// 通过调用命令将活动单元格移动到上一个单元格
spread.commandManager().execute({cmd: "moveToPreviousCell", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

moveToPreviousCellThenControl

• moveToPreviousCellThenControl: Object

表示用于在活动单元格是第一个可见单元格时选择上一个控件；否则将活动单元格移动到上一个单元格的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例映射moveToPreviousCellThenControl动作。
spread.commandManager().setShortcutKey('moveToNextCellThenControl', GC.Spread.Commands.Key.tab, false, false, false, false); // Tab键
spread.commandManager().setShortcutKey('moveToPreviousCellThenControl', GC.Spread.Commands.Key.tab, false, true, false, false); // Shift键和Tab键

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationBottom

• navigationBottom: Object

表示用于将活动单元格移动到最后一行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例将navigationBottom动作映射到Tab键。
spread.commandManager().setShortcutKey('navigationDown', GC.Spread.Commands.Key.tab, false, false, false, false); // Tab键
spread.commandManager().setShortcutKey('navigationBottom', GC.Spread.Commands.Key.tab, false, true, false, false); // Shift键和Tab键

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationDown

• navigationDown: Object

表示用于将活动单元格移动到下一行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例映射navigationDown键。
spread.commandManager().setShortcutKey('navigationDown', GC.Spread.Commands.Key.tab, false, false, false, false); // Tab键
spread.commandManager().setShortcutKey('navigationBottom', GC.Spread.Commands.Key.tab, false, true, false, false); // Shift键和Tab键

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationEnd

• navigationEnd: Object

表示用于将活动单元格移动到最后一列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationEnd方法。
spread.commandManager().setShortcutKey('navigationEnd', GC.Spread.Commands.Key.tab,  false, false, false, false); // Tab键

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationEnd2

• navigationEnd2: Object

表示用于将活动单元格移动到最后一列的命令，不考虑冻结的尾列。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationEnd2动作。
spread.commandManager().setShortcutKey("navigationEnd2", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationFirst

• navigationFirst: Object

表示用于将活动单元格移动到工作表中第一个单元格的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationFirst动作。
spread.commandManager().setShortcutKey("navigationFirst", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationHome

• navigationHome: Object

表示用于将活动单元格移动到第一列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationHome动作。
spread.commandManager().setShortcutKey("navigationHome", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationHome2

• navigationHome2: Object

表示用于将活动单元格移动到第一列的命令，不考虑冻结的列。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationHome2动作。
spread.commandManager().setShortcutKey("navigationHome2", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationLast

• navigationLast: Object

表示用于将活动单元格移动到工作表中最后一个单元格的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationLast动作。
spread.commandManager().setShortcutKey("navigationLast", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationLeft

• navigationLeft: Object

表示用于将活动单元格移动到前一列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationLeft动作。
spread.commandManager().setShortcutKey("navigationLeft", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationNextSheet

• navigationNextSheet: Object

表示用于将活动工作表移动到下一个工作表的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationNextSheet动作。
spread.commandManager().setShortcutKey("navigationNextSheet", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationPageDown

• navigationPageDown: Object

表示用于将活动单元格向下移动一页行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationPageDown动作。
spread.commandManager().setShortcutKey("navigationPageDown", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationPageUp

• navigationPageUp: Object

表示用于将活动单元格向上移动一页行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationPageUp动作。
spread.commandManager().setShortcutKey("navigationPageUp", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationPreviousSheet

• navigationPreviousSheet: Object

表示用于将活动工作表移动到上一个工作表的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationPreviousSheet动作。
spread.commandManager().setShortcutKey("navigationNextSheet", GC.Spread.Commands.Key.a, false, false, false, false);
spread.commandManager().setShortcutKey("navigationPreviousSheet", GC.Spread.Commands.Key.c, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

navigationRight

• navigationRight: Object

表示用于将活动单元格移动到下一列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationRight动作。
spread.commandManager().setShortcutKey("navigationRight", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationTop

• navigationTop: Object

表示用于将活动单元格移动到第一行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例使用navigationTop动作。
spread.commandManager().setShortcutKey("navigationTop", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

navigationUp

• navigationUp: Object

表示用于将活动单元格移动到上一行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例将navigationUp动作映射到a键。
spread.commandManager().setShortcutKey('navigationUp', GC.Spread.Commands.Key.a, false, false, false, false); // a

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

openCalculator

• openCalculator: Object

表示用于在指定单元格中打开计算器选择器的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.sheetArea - 工作表区域。

property options.row - 行索引。

property options.col - 列索引。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开计算器
spread.commandManager().execute({cmd: "openCalculator", sheetName: "Sheet1", row: 1, col: 2});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetArea`: `SheetArea` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

openColorPicker

• openColorPicker: Object

表示用于在指定单元格中打开颜色选择器的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.sheetArea - 工作表区域。

property options.row - 行索引。

property options.col - 列索引。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开颜色选择器
spread.commandManager().execute({cmd: "openColorPicker", sheetName: "Sheet1", row: 1, col: 2});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetArea`: `SheetArea` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

openDateTimePicker

• openDateTimePicker: Object

表示用于在指定单元格中打开日期时间选择器的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.sheetArea - 工作表区域。

property options.row - 行索引。

property options.col - 列索引。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开日期时间选择器
spread.commandManager().execute({cmd: "openDateTimePicker", sheetName: "Sheet1", row: 1, col: 2});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetArea`: `SheetArea` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

openList

• openList: Object

表示用于在指定单元格中打开列表选择器的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.sheetArea - 工作表区域。

property options.row - 行索引。

property options.col - 列索引。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开列表
spread.commandManager().execute({cmd: "openList", sheetName: "Sheet1", row: 1, col: 2});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetArea`: `SheetArea` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

openMonthPicker

• openMonthPicker: Object

表示用于在指定单元格中打开月份选择器的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.sheetArea - 工作表区域。

property options.row - 行索引。

property options.col - 列索引。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开月份选择器
spread.commandManager().execute({cmd: "openMonthPicker", sheetName: "Sheet1", row: 1, col: 2});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetArea`: `SheetArea` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

openMultiColumn

• openMultiColumn: Object

表示用于在指定单元格中打开多列列表选择器的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.sheetArea - 工作表区域。

property options.row - 行索引。

property options.col - 列索引。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开多列列表
spread.commandManager().execute({cmd: "openMultiColumn", sheetName: "Sheet1", row: 1, col: 2});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetArea`: `SheetArea` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

openPasteSpecialDialog

• openPasteSpecialDialog: Object

表示用于打开选择性粘贴对话框的命令。

property context 操作的上下文。

example

// 此示例打开选择性粘贴对话框。
spread.commandManager().execute({cmd: "openPasteSpecialDialog", sheetName: spread.getActiveSheet().name()});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`) => `void`

openSlider

• openSlider: Object

表示用于在指定单元格中打开滑块选择器的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.sheetArea - 工作表区域。

property options.row - 行索引。

property options.col - 列索引。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开滑块
spread.commandManager().execute({cmd: "openSlider", sheetName: "Sheet1", row: 1, col: 2});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetArea`: `SheetArea` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

openTimePicker

• openTimePicker: Object

表示用于在指定单元格中打开时间选择器的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.sheetArea - 工作表区域。

property options.row - 行索引。

property options.col - 列索引。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开时间选择器
spread.commandManager().execute({cmd: "openTimePicker", sheetName: "Sheet1", row: 1, col: 2});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetArea`: `SheetArea` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

openUrl

• openUrl: Object

表示用于打开超链接单元格URL的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.url - URL字符串。

property options.target - 目标类型，默认为blank。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开超链接单元格的URL
spread.commandManager().execute({cmd: "openUrl", sheetName: "Sheet1", url: "https://www.spreadjs.com", target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.blank});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` ; `target?`: `HyperlinkTargetType` ; `url`: `string` }, `isUndo`: `boolean`) => `any`

openWorkflowList

• openWorkflowList: Object

表示用于在指定单元格中打开工作流列表选择器的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.sheetArea - 工作表区域。

property options.row - 行索引。

property options.col - 列索引。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令打开工作流列表
spread.commandManager().execute({cmd: "openWorkflowList", sheetName: "Sheet1", row: 1, col: 2});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `row`: `number` ; `sheetArea`: `SheetArea` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

outlineColumn

• outlineColumn: Object

表示用于在工作表上对列大纲（范围组）进行分组的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.index - 大纲起始索引。

property options.count - 要在大纲中分组或取消分组的行或列数。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例创建一个组。
spread.options.allowUndo = true;
spread.commandManager().execute({cmd: "outlineColumn", sheetName: "Sheet1", index: 3, count: 5});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `count`: `number` ; `index`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

outlineRow

• outlineRow: Object

表示用于在工作表上对行大纲（范围组）进行分组的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.index - 大纲起始索引。

property options.count - 要在大纲中分组或取消分组的行或列数。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//此示例撤销一个操作。
spread.options.allowUndo = true;
spread.commandManager().execute({cmd: "outlineRow", sheetName: "Sheet1", index: 3, count: 5});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `count`: `number` ; `index`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

paste

• paste: Object

表示用于将剪贴板中的选定项目粘贴到当前工作表的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.shiftCells - 插入的数据需要移动的方向。

property options.pasteOption - 粘贴的选项。

property options.pasteText - 剪贴板的粘贴文本。

property options.pasteHtml - 剪贴板的粘贴HTML。

property options.pasteSpecialOptions

property options.pasteSpecialOptions.operationOptions 粘贴操作的选项。

property options.pasteSpecialOptions.skipBlanks - 是否跳过复制范围内的空白单元格而不替换相应的单元格。

property options.pasteSpecialOptions.transpose - 是否将复制的数据的列转换为行，反之亦然。

property options.pasteSpecialOptions.pasteLink - 是否粘贴单元格引用。

property isUndo - 如果是撤销操作则为true；否则为false。

example

//通过调用命令将剪贴板中的选定项目粘贴到当前工作表
spread.commandManager().execute({cmd: "paste", sheetName: "Sheet1", pasteText: "test"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `pasteOption`: `ClipboardPasteOptions` ; `pasteSpecialOptions`: `Object` ; `sheetName`: `string` ; `shiftCells?`: `InsertShiftCell` }) => `any`

pasteFloatingObjects

• pasteFloatingObjects: Object

表示用于在工作表上粘贴浮动对象的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令粘贴浮动对象
spread.commandManager().execute({cmd: "pasteFloatingObjects", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

redo

• redo: Object

表示用于重做最近撤销的编辑或操作的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用重做命令。
spread.commandManager().execute({cmd: "redo", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

removeColumnOutline

• removeColumnOutline: Object

表示用于取消工作表上列大纲（范围组）分组的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.index - 大纲起始索引。

property options.count - 大纲中要分组或取消分组的行或列数。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令取消列大纲分组
spread.commandManager().execute({cmd: "removeColumnOutline", sheetName: "Sheet1", index: 1, count: 3});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `count`: `number` ; `index`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

removeRowOutline

• removeRowOutline: Object

表示用于取消工作表上行大纲（范围组）分组的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.index - 大纲起始索引。

property options.count - 大纲中要分组或取消分组的行或列数。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令取消行大纲分组
spread.commandManager().execute({cmd: "removeRowOutline", sheetName: "Sheet1", index: 1, count: 3});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `count`: `number` ; `index`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

renameSheet

• renameSheet: Object

表示用于重命名工作表的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.name - 工作表的新名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例重命名工作表。
spread.commandManager().execute({cmd: "renameSheet", sheetName: "Sheet1", name: "SheetName"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `name`: `string` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

reportSheetAddRecord

• reportSheetAddRecord: Object

表示用于在报表中添加记录的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.activeRow - 添加记录的活动行号。

property options.activeCol - 添加记录的活动列号。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令在数据录入模式下在报表中添加记录
spread.commandManager().execute({cmd: "reportSheetAddRecord", sheetName: "Report1", activeRow: 1, activeCol: 1});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `activeCol`: `number` ; `activeRow`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

reportSheetCollapseAll

• reportSheetCollapseAll: Object

表示用于折叠报表中所有折叠按钮的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property {GC.Spread.Sheets.Range[]} options.selections - 折叠按钮选择范围。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令在数据录入模式下折叠所有折叠按钮
spread.commandManager().execute({cmd: "reportSheetCollapseAll", sheetName: "Report1", selections: [new GC.Spread.Sheets.Range(1, 1, 1, 1)]});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `selections`: `Range`[] ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

reportSheetDeleteRecord

• reportSheetDeleteRecord: Object

表示用于删除报表中记录的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.activeRow - 被删除记录的活动行号。

property options.activeCol - 被删除记录的活动列号。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令在数据录入模式下删除报表中的记录
spread.commandManager().execute({cmd: "reportSheetDeleteRecord", sheetName: "Report1", activeRow: 2, activeCol: 1});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `activeCol`: `number` ; `activeRow`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

reportSheetExpandAll

• reportSheetExpandAll: Object

表示用于展开报表中所有折叠按钮的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property {GC.Spread.Sheets.Range[]} options.selections - 折叠按钮选择范围。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令在数据录入模式下展开所有折叠按钮
spread.commandManager().execute({cmd: "reportSheetExpandAll", sheetName: "Report1", selections: [new GC.Spread.Sheets.Range(1, 1, 1, 1)]});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `selections`: `Range`[] ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

reportSheetRegenerateReport

• reportSheetRegenerateReport: Object

表示用于重新生成报表的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令重新生成报表
spread.commandManager().execute({cmd: "reportSheetRegenerateReport", sheetName: "Report1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

reportSheetResetCellValue

• reportSheetResetCellValue: Object

表示用于重置报表中所有选中单元格值的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property {GC.Spread.Sheets.Range[]} options.selections - 重置值的选择范围。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令在数据录入模式下重置所有选中单元格的值
spread.commandManager().execute({cmd: "reportSheetResetCellValue", sheetName: "Report1", selections: [new GC.Spread.Sheets.Range(1, 1, 1, 1)]});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `selections`: `Range`[] ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

reportSheetSubmit

• reportSheetSubmit: Object

表示用于提交报表中数据录入更改的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令提交数据录入更改
spread.commandManager().execute({cmd: "reportSheetSubmit", sheetName: "Report1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

resizeColumn

• resizeColumn: Object

表示用于调整工作表中列宽的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.columns - 要调整的列；每个项目都是一个包含firstCol和lastCol的对象。

property options.size - 正在调整的列的宽度。

property options.rowHeader - 正在调整的列是否在行标题区域。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令调整列宽
spread.commandManager().execute({cmd: "resizeColumn", sheetName: "Sheet1", columns: [{firstCol: 1, lastCol: 5}], size: 200, rowHeader: false});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `columns`: `Object`[] ; `rowHeader`: `boolean` ; `sheetName`: `string` ; `size`: `number` }, `isUndo`: `boolean`) => `any`

resizeFloatingObjects

• resizeFloatingObjects: Object

表示用于调整浮动对象的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.floatingObjects - 浮动对象的名称数组。

property options.offsetX - 左侧偏移量。

property options.offsetY - 顶部偏移量。

property options.offsetWidth - 宽度偏移量。

property options.offsetHeight - 高度偏移量。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令调整浮动对象大小
spread.commandManager().execute({cmd: "resizeFloatingObjects", sheetName: "Sheet1", floatingObjects: ["floatingObject1", "floatingObject2"], offsetWidth: 100, offsetHeight: 100});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `floatingObjects`: `string`[] ; `offsetHeight`: `number` ; `offsetWidth`: `number` ; `offsetX`: `number` ; `offsetY`: `number` ; `sheetName`: `string` }, `isUndo`: `boolean`) => `boolean`

resizeRow

• resizeRow: Object

表示用于调整工作表中行高的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.rows - 要调整的行；每个项目都是一个包含firstRow和lastRow的对象。

property options.size - 正在调整的行的高度。

property options.columnHeader - 正在调整的行是否在列标题区域。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令调整行高
spread.commandManager().execute({cmd: "resizeRow", sheetName: "Sheet1", rows: [{firstRow: 1, lastRow: 5}], size: 100, rowHeader: false});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `columnHeader`: `boolean` ; `rows`: `Object`[] ; `sheetName`: `string` ; `size`: `number` }, `isUndo`: `boolean`) => `any`

selectNextControl

• selectNextControl: Object

表示用于选择下一个控件的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例将selectNextControl动作映射到Tab键。
spread.commandManager().setShortcutKey('selectNextControl', GC.Spread.Commands.Key.tab, false, false, false, false); // Tab键
spread.commandManager().setShortcutKey('selectPreviousControl', GC.Spread.Commands.Key.tab, false, true, false, false); // Shift键和Tab键

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectPreviousControl

• selectPreviousControl: Object

表示用于选择上一个控件的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例将selectPreviousControl动作映射到Shift + Tab键组合。
spread.commandManager().setShortcutKey('selectNextControl', GC.Spread.Commands.Key.tab, false, false, false, false); // Tab键
spread.commandManager().setShortcutKey('selectPreviousControl', GC.Spread.Commands.Key.tab, false, true, false, false); // Shift键和Tab键

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionBottom

• selectionBottom: Object

表示用于将选择扩展到最后一行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionBottom动作。
spread.commandManager().setShortcutKey('selectionBottom', GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionDown

• selectionDown: Object

表示用于将选择向下扩展一行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionDown动作。
spread.commandManager().setShortcutKey('selectionDown', GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionEnd

• selectionEnd: Object

表示用于将选择扩展到最后一列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionEnd动作。
spread.focus();
spread.commandManager().setShortcutKey('selectionEnd', GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionFirst

• selectionFirst: Object

表示用于将选择扩展到第一个单元格的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionFirst动作。
spread.focus();
spread.commandManager().setShortcutKey('selectionFirst', GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionHome

• selectionHome: Object

表示用于将选择扩展到第一列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionHome动作。
spread.focus();
spread.commandManager().setShortcutKey('selectionHome', GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionLast

• selectionLast: Object

表示用于将选择扩展到最后一个单元格的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionLast动作。
spread.focus();
spread.commandManager().setShortcutKey('selectionLast', GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionLeft

• selectionLeft: Object

表示用于将选择向左扩展一列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionLeft动作。
spread.commandManager().setShortcutKey('selectionLeft', GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }, `isUndo`: `boolean`) => `any`

selectionPageDown

• selectionPageDown: Object

表示用于将选择向下扩展一页行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionPageDown动作。
spread.commandManager().setShortcutKey('selectionPageDown', GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionPageUp

• selectionPageUp: Object

表示用于将选择向上扩展一页行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionPageUp动作。
spread.commandManager().setShortcutKey('selectionPageUp', GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionRight

• selectionRight: Object

Represents the command used to extend the selection one column to the right.

property canUndo - indicates whether the command supports undo and redo operations.

property execute - performs an execute or undo operation. The arguments of the execute method are as follows.

property context - The context of the operation.

property options - The options of the operation.

property options.sheetName - The sheet name.

property isUndo - true if this is an undo operation; otherwise, false.

example

//This example uses the selectionRight action.
spread.commandManager().setShortcutKey("selectionRight", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionTop

• selectionTop: Object

Represents the command used to extend the selection to the first row.

property canUndo - indicates whether the command supports undo and redo operations.

property execute - performs an execute or undo operation. The arguments of the execute method are as follows.

property context - The context of the operation.

property options - The options of the operation.

property options.sheetName - The sheet name.

property isUndo - true if this is an undo operation; otherwise, false.

example

//This example uses the selectionTop action.
spread.commandManager().setShortcutKey("selectionTop", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

selectionUp

• selectionUp: Object

表示用于将选择向上扩展一行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用selectionUp动作。
spread.commandManager().setShortcutKey("selectionUp", GC.Spread.Commands.Key.a, false, false, false, false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

splitResizeColumn

• splitResizeColumn: Object

表示用于在工作表上拆分调整列宽的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.columns - 要调整的列；每个项目都是一个包含firstCol和lastCol的对象。

property options.size - 正在调整的列的尺寸。

property options.rowHeader - 正在调整的列是否在行标题区域。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令拆分调整列宽
spread.commandManager().execute({cmd: "splitResizeColumn", sheetName: "Sheet1", columns: [{firstCol: 1, lastCol: 2}]}, size: 100, rowHeader: false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `columns`: `Object`[] ; `rowHeader`: `boolean` ; `sheetName`: `string` ; `size`: `number` }, `isUndo`: `boolean`) => `any`

splitResizeRow

• splitResizeRow: Object

表示用于在工作表上拆分调整行高的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.rows - 要调整的行；每个项目都是一个包含firstRow和lastRow的对象。

property options.size - 正在调整的行的尺寸。

property options.columnHeader - 正在调整的行是否在列标题区域。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令拆分调整行高
spread.commandManager().execute({cmd: "splitResizeRow", sheetName: "Sheet1", rows: [{firstRow: 1, lastRow: 2}]}, size: 100, columnHeader: false);

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `columnHeader`: `boolean` ; `rows`: `Object`[] ; `sheetName`: `string` ; `size`: `number` }, `isUndo`: `boolean`) => `any`

startEdit

• startEdit: Object

表示用于以编辑模式开始编辑活动单元格的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令开始编辑单元格
spread.commandManager().execute({cmd: "startEdit", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

tableDeleteColumns

• tableDeleteColumns: Object

表示用于删除表格列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.tableName - 表格名称。

property options.col - 要删除的起始列索引，列索引基于表格索引。

property options.count - 要删除的列数。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令删除表格列
spread.commandManager().execute({cmd: "tableDeleteColumns", sheetName: "Sheet1", tableName: "table1", col: 1, count: 3});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `count`: `number` ; `sheetName`: `string` ; `tableName`: `string` }, `isUndo`: `boolean`) => `boolean`

tableDeleteRows

• tableDeleteRows: Object

表示用于删除表格行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.tableName - 表格名称。

property options.row - 要删除的起始行索引，行索引基于表格索引。

property options.count - 要删除的行数。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令删除表格行
spread.commandManager().execute({cmd: "tableDeleteRows", sheetName: "Sheet1", tableName: "table1", row: 1, count: 3});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `count`: `number` ; `row`: `number` ; `sheetName`: `string` ; `tableName`: `string` }, `isUndo`: `boolean`) => `boolean`

tableInsertColumns

• tableInsertColumns: Object

表示用于插入表格列的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.tableName - 表格名称。

property options.col - 要插入的起始列索引，列索引基于表格索引。

property options.count - 要插入的列数。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令插入表格列
spread.commandManager().execute({cmd: "tableInsertColumns", sheetName: "Sheet1", tableName: "table1", col: 1, count: 3});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `col`: `number` ; `count`: `number` ; `sheetName`: `string` ; `tableName`: `string` }, `isUndo`: `boolean`) => `boolean`

tableInsertRows

• tableInsertRows: Object

表示用于插入表格行的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.tableName - 表格名称。

property options.row - 要插入的起始行索引，行索引基于表格索引。

property options.count - 要插入的行数。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令插入表格行
spread.commandManager().execute({cmd: "tableInsertRows", sheetName: "Sheet1", tableName: "table1", row: 1, count: 3});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `count`: `number` ; `row`: `number` ; `sheetName`: `string` ; `tableName`: `string` }, `isUndo`: `boolean`) => `boolean`

tableResize

• tableResize: Object

表示用于调整表格大小的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.tableName - 表格名称。

property options.resizeToRange - 调整后的表格范围。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令调整表格大小
spread.commandManager().execute({cmd: "tableResize", sheetName: "Sheet1", tableName: "table1", resizeToRange: new GC.Spread.Sheets.Range(1, 1, 5, 3)});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `resizeToRange`: `Range` ; `sheetName`: `string` ; `tableName`: `string` }, `isUndo`: `boolean`) => `boolean`

tableSubmitChanges

• tableSubmitChanges: Object

表示用于提交绑定数据管理器表格的表格更改的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property [options.sheetName] 工作表名称，默认为活动工作表。

property {string[]} [options.tableNames] 表格名称，默认为活动表格。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令提交绑定数据管理器表格的表格更改
spread.commandManager().execute({cmd: "tableSubmitChanges", sheetName: "Sheet1", tableNames: ["table1"]});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName?`: `string` ; `tableNames?`: `string`[] }, `isUndo`: `boolean`) => `boolean`

undo

• undo: Object

表示用于撤销最近一次编辑或操作的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 此示例使用撤销命令
spread.commandManager().execute({cmd: "undo", sheetName: "Sheet1"});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` }) => `any`

zoom

• zoom: Object

表示用于缩放工作表的命令。

property canUndo - 指示命令是否支持撤销和重做操作。

property execute - 执行或撤销操作。

execute方法的参数如下。

property context - 操作的上下文。

property options - 操作的选项。

property options.sheetName - 工作表名称。

property options.zoomFactor - 缩放因子。

property isUndo - 如果是撤销操作则为true；否则为false。

example

// 通过调用命令缩放工作表
spread.commandManager().execute({cmd: "zoom", sheetName: "Sheet1", zoomFactor: 3});

Type declaration

Name	Type
`canUndo`	`boolean`
`execute`	(`context`: `Workbook`, `options`: { `sheetName`: `string` ; `zoomFactor`: `number` }, `isUndo`: `boolean`) => `any`

Functions

endTransaction

▸ endTransaction(context, options): void

结束事务。在事务期间，数据模型的更改将被保存。

property context - 操作的上下文。

property options - 操作的选项。

property {string|string[]} [options.sheetName] 工作表名称。如果当前事务需要更改多个工作表，则sheetName可以是字符串数组。

example

// 例如，以下代码注册changeBackColor命令然后执行该命令。
var command = {
  canUndo: true,
  execute: function (context, options, isUndo) {
    var Commands = GC.Spread.Sheets.Commands;
    options.cmd = "changeBackColor";
    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("ss"));
var commandManager = spread.commandManager();
commandManager.register("changeBackColor", command);
commandManager.execute({cmd: "changeBackColor", sheetName: spread.getSheet(0).name(), row: 1, col: 2, backColor: "red"});

Parameters

Name	Type
`context`	`Workbook`
`options`	`any`

Returns

void

startTransaction

▸ startTransaction(context, options): void

开始事务。在事务期间，数据模型的更改将被保存。

property context - 操作的上下文。

property options - 操作的选项。

property {string|string[]} [options.sheetName] 工作表名称。如果当前事务需要更改多个工作表，则sheetName可以是字符串数组。

example

// 例如，以下代码注册changeBackColor命令然后执行该命令。
var command = {
  canUndo: true,
  execute: function (context, options, isUndo) {
    var Commands = GC.Spread.Sheets.Commands;
    options.cmd = "changeBackColor";
    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("ss"));
var commandManager = spread.commandManager();
commandManager.register("changeBackColor", command);
commandManager.execute({cmd: "changeBackColor", sheetName: spread.getSheet(0).name(), row: 1, col: 2, backColor: "red"});

Parameters

Name	Type
`context`	`Workbook`
`options`	`any`

Returns

void

undoTransaction

▸ undoTransaction(context, options): void

撤销事务中进行的更改。

property context - 操作的上下文。

property options - 操作的选项。

property {string|string[]} [options.sheetName] 工作表名称。如果当前事务需要更改多个工作表，则sheetName可以是字符串数组。

example

// 例如，以下代码注册changeBackColor命令然后执行该命令。
var command = {
  canUndo: true,
  execute: function (context, options, isUndo) {
    var Commands = GC.Spread.Sheets.Commands;
    options.cmd = "changeBackColor";
    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("ss"));
var commandManager = spread.commandManager();
commandManager.register("changeBackColor", command);
commandManager.execute({cmd: "changeBackColor", sheetName: spread.getSheet(0).name(), row: 1, col: 2, backColor: "red"});

Parameters

Name	Type
`context`	`Workbook`
`options`	`any`

Returns

void

GC.Spread.Sheets.Commands

Namespace: Commands

Table of contents

Variables

Functions

Variables

DefineColumn

Type declaration

ModifyColumn

Type declaration

RemoveColumn

Type declaration

ReportChartPreviewVisible

Type declaration

ReportCollapseButtonToggle

Type declaration

autoFitColumn

Type declaration

autoFitRow

Type declaration

cancelInput

Type declaration

changeEditorStatus

Type declaration

changeFormulaReference

Type declaration

clear

Type declaration

clearAndEditing

Type declaration

clearValues

Type declaration

clipboardPaste

Type declaration

commitArrayFormula

Type declaration

commitInputNavigationDown

Type declaration

commitInputNavigationUp

Type declaration

copy

Type declaration

copySheet

Type declaration

cut

Type declaration

deleteFloatingObjects

Type declaration

dragCopyFloatingObjects

Type declaration

dragDrop

Type declaration

editCell

Type declaration

expandColumnOutline

Type declaration

expandColumnOutlineForLevel

Type declaration

expandRowOutline

Type declaration

expandRowOutlineForLevel

Type declaration

fill

Type declaration

moveFloatingObjects

Type declaration

moveSheet

Type declaration

moveToNextCell

Type declaration

moveToNextCellThenControl

Type declaration

moveToPreviousCell

Type declaration

moveToPreviousCellThenControl

Type declaration

navigationBottom

Type declaration

navigationDown

Type declaration