[]
        
(Showing Draft Content)

GC.Spread.Sheets.Commands

名前空間: Commands

Spread.Sheets.Commands

Table of contents

変数

関数

変数

DefineColumn

DefineColumn: Object

列を定義するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 挿入用の指定された列(オプション)。

パラメータ 定義した列。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、列の定義操作を使用します。
// 列のプロパティを定義します。
spread.commandManager().execute({cmd: "DefineColumn", sheetName: "Sheet1", { col: 1, column: { value: 'column1' }}});

型宣言

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

ModifyColumn

ModifyColumn: Object

列を変更するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 指定された列。

パラメータ 変更された列。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、列の変更操作を使用します。
// 列のプロパティを変更します。
spread.commandManager().execute({cmd: "ModifyColumn", sheetName: "Sheet1", { col: 1, column: { value: 'column1' }}});

型宣言

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

RemoveColumn

RemoveColumn: Object

列を削除するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 指定された列。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、列の削除操作を使用します。
// 列のプロパティを削除します。
spread.commandManager().execute({cmd: "RemoveColumn", sheetName: "Sheet1", { col: 1 }});

型宣言

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

autoFitColumn

autoFitColumn: Object

シートの列を自動的にサイズ変更するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ サイズ変更する列。各要素は、列を持つオブジェクトです。

パラメータ サイズ変更された列が行ヘッダ領域にあるかどうか。

パラメータ 自動サイズ調整アクションにヘッダテキストを含めるかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

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});

型宣言

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

autoFitRow

autoFitRow: Object

シートの行を自動的にサイズ変更するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ サイズ変更する行。各要素は、行を持つオブジェクトです。

パラメータ サイズ変更された行が列ヘッダ領域にあるかどうか。

パラメータ 自動サイズ調整アクションにヘッダテキストを含めるかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

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});

型宣言

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

cancelInput

cancelInput: Object

セルの編集を終了して入力をキャンセルするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してセルの編集を停止します。
// 次のサンプルコードは、 2 秒後に入力エディタをキャンセルします。
activeSheet.setValue(0, 0, '12312');
activeSheet.startEdit();
window.setTimeout(function() {
    spread.commandManager().execute({ cmd: "cancelInput", sheetName: "Sheet1" });
}, 2000);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

changeFormulaReference

changeFormulaReference: Object

数式を編集するときに数式参照を相対、絶対、混合の間で切り替えるためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、 それ以外の場合はfalse.。
// 次のサンプルコードは、changeFormulaReference アクションを使用して数式参照を切り替える方法を示します。
spread.commandManager().execute({cmd: "changeFormulaReference", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

clear

clear: Object

セル値をクリアするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

//タブキーで選択したセルをクリアします。
spread.commandManager().setShortcutKey('clear', GC.Spread.Commands.Key.tab, false, false, false, false); //タブキー

// コマンドを呼び出して選択したセルをクリアします。
spread.commandManager().execute({cmd: "clear", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

clearAndEditing

clearAndEditing: Object

アクティブセルの値をクリアして編集モードに入るためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してアクティブセルをクリアし、編集モードに入ります。
spread.commandManager().execute({cmd: "clearAndEditing", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

clearValues

clearValues: Object

ワークシートのセル値をクリアするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 値をクリアするセル範囲。要素の型はGC.Spread.Sheets.Rangeです。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

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

型宣言

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

clipboardPaste

clipboardPaste: Object

ワークシートでクリップボードからの貼り付けを行うためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ ソースシート。

パラメータ 要素の型はGC.Spread.Sheets.Rangeであるソース範囲の配列。

パラメータ 要素の型はGC.Spread.Sheets.Rangeである対象範囲の配列。

パラメータ 操作が切り取りとコピーのどちらであるか。

パラメータ クリップボード上のテキスト。

パラメータ 貼り付ける内容を示すクリップボード貼り付けオプション。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、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});
});
// ボタンコントロールをページを追加します。
<input type="button" id="button1" value="button1"/>
<input type="button" id="button2" value="button2"/>

型宣言

名前
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

セルの編集を確定して配列数式をアクティブな範囲に設定するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してセルの編集をコミットし、配列数式をアクティブな範囲に設定します。
spread.commandManager().execute({cmd: "commitArrayFormula", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

commitInputNavigationDown

commitInputNavigationDown: Object

セルの編集を終了してアクティブセルを次の行に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してセルの編集を停止し、アクティブなセルを次の行に移動します。
activeSheet.setValue(1, 1, '12312');
activeSheet.setActiveCell(1,1);
activeSheet.startEdit();
window.setTimeout(function() {
    spread.commandManager().execute({cmd: "commitInputNavigationDown", sheetName: "Sheet1"});
}, 1000);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

commitInputNavigationUp

commitInputNavigationUp: Object

セルの編集を終了してアクティブセルを前の行に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してセルの編集を停止し、アクティブなセルを前の行に移動します。
activeSheet.setValue(1, 1, 'SpreadJS');
activeSheet.setActiveCell(1,1);
activeSheet.startEdit();
window.setTimeout(function() {
    spread.commandManager().execute({cmd: "commitInputNavigationUp", sheetName: "Sheet1"});
}, 1000);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

copy

copy: Object

選択されている項目のテキストをクリップボードにコピーするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して、選択した項目のテキストをクリップボードにコピーします。
spread.commandManager().execute({cmd: "copy", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

copySheet

copySheet: Object

シートのコピーに使用されるコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ クローンしたシート名。

パラメータ 対象インデックス。

パラメータ 新しいシート名。

パラメータ データソースを複製されたシートに連結するかどうか。

実例

// 次のサンプルコードは、シートをコピーします。
spread.commandManager().execute({cmd: "copySheet", sheetName: "Sheet1", targetIndex: targetIndex, newName: "Sheet1 (2)", includeBindingSource: true});

型宣言

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

cut

cut: Object

選択されている項目のテキストをクリップボードに切り取るためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して、選択した項目のテキストをクリップボードに切り取ります。
spread.commandManager().execute({cmd: "cut", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

deleteFloatingObjects

deleteFloatingObjects: Object

フローティングオブジェクトを削除するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してフローティングオブジェクトを削除します。
spread.commandManager().execute({cmd: "deleteFloatingObjects", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }, isUndo: boolean) => boolean

dragCopyFloatingObjects

dragCopyFloatingObjects: Object

シート上のフローティングオブジェクトをドラッグ&コピーするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ フローティングオブジェクトの名前の配列。

パラメータ 水平方向のオフセット。

パラメータ 垂直方向のオフセット。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してフローティングオブジェクトをコピーします。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("floatingObject1", 10, 10, 60, 64);
var div = document.createElement('div');
div.innerHTML = '<span> SpreadJS supports FloatingObject.</span>'+
'<div style="border: 1px dotted  gray; width: 60%; height:70%; margin:auto;">' +
'<ul><li>First list</li></ul><ul><li>Second list</li></ul></div>';
customFloatingObject.content(div);
activeSheet.floatingObjects.add(customFloatingObject);
spread.commandManager().execute({cmd: "dragCopyFloatingObjects", sheetName: "Sheet1", floatingObjects: ["floatingObject1"], offsetX: 100, offsetY: 200});

型宣言

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

dragDrop

dragDrop: Object

範囲をドラッグしてワークシート上の別の範囲の上にドロップするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

param 操作のコンテキスト。commandOptions 操作のオプション。commandOptions.sheetName シート名。commandOptions.fromRow ドラッグ&ドロップのドラッグ元の行インデックス。commandOptions.fromColumn ドラッグ&ドロップのドラッグ元の列インデックス。commandOptions.toRow ドラッグ&ドロップのドロップ先の行インデックス。commandOptions.toColumn ドラッグ&ドロップのドロップ先の列インデックス。commandOptions.rowCount ドラッグ&ドロップの行数。commandOptions.columnCount ドラッグ&ドロップの列数。commandOptions.copy コピーする場合はtrue、切り取る場合はfalse。commandOptions.insert trueに設定した場合、ドラッグデータがドロップ行またはドロップ列に挿入されます。commandOptions.option ドラッグ&ドロップする内容のタイプを示します。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

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});

型宣言

名前
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

ワークシートのセルに新しい値を適用するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ セルの行インデックス。

パラメータ セルの列インデックス。

パラメータ セルの新しい値。

パラメータ 新しい値を自動的に書式するかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して新しい値をセルに適用します。
spread.commandManager().execute({cmd: "editCell", sheetName: "Sheet1", row: 1, col: 1, newValue: "123", autoFormat: true});

型宣言

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

expandColumnOutline

expandColumnOutline: Object

列範囲グループを展開または折りたたむためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ アウトライン要約インデックス。

パラメータ アウトラインレベル。

パラメータ アウトラインを折りたたむか展開するかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して列範囲グループを折りたたみます。
spread.commandManager().execute({cmd: "expandColumnOutline", sheetName: "Sheet1", index: 5, level: 0, collapsed: true});

型宣言

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

expandColumnOutlineForLevel

expandColumnOutlineForLevel: Object

同じレベルの列範囲グループを展開または折りたたむためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ アウトラインレベル。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して列範囲グループを展開または折りたたみます。
spread.commandManager().execute({cmd: "expandColumnOutlineForLevel", sheetName: "Sheet1", level: 0});

型宣言

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

expandRowOutline

expandRowOutline: Object

行範囲グループを展開または折りたたむためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ アウトライン要約インデックス。

パラメータ アウトラインレベル。

パラメータ アウトラインを折りたたむか展開するかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して行範囲グループを展開します。
spread.commandManager().execute({cmd: "expandRowOutline", sheetName: "Sheet1", index: 5, level: 0, collapsed: false});

型宣言

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

expandRowOutlineForLevel

expandRowOutlineForLevel: Object

同じレベルの行範囲グループを展開または折りたたむためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ アウトラインレベル。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して行範囲グループを展開または折りたたみます。
spread.commandManager().execute({cmd: "expandRowOutlineForLevel", sheetName: "Sheet1", level: 0});

型宣言

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

fill

fill: Object

シートの範囲をドラッグフィルするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 開始範囲。

パラメータ フィル範囲。

パラメータ オートフィルタイプ。

パラメータ フィルの方向。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

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 });

型宣言

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

moveFloatingObjects

moveFloatingObjects: Object

フローティングオブジェクトを移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ フローティングオブジェクトの名前の配列。

パラメータ 水平方向のオフセット。

パラメータ 垂直方向のオフセット。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してフローティングオブジェクトを移動します。
spread.commandManager().execute({cmd: "moveFloatingObjects", sheetName: "Sheet1", floatingObjects: ["floatingObject1", "floatingObject2"], offsetX: 10, offsetY: 20});

型宣言

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

moveSheet

moveSheet: Object

シートの移動に使用されるコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 対象インデックス。

実例

// 次のサンプルコードは、シートを移動します。
spread.commandManager().execute({cmd: "moveSheet", sheetName: "Sheet1", targetIndex: targetIndex});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string ; targetIndex: number }) => boolean

moveToNextCell

moveToNextCell: Object

アクティブセルを次のセルに移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、moveToNextCell操作をマップします。
spread.focus();
spread.commandManager().setShortcutKey('moveToNextCell', GC.Spread.Commands.Key.a, false, false, false, false); // a

// コマンドを呼び出して、アクティブなセルを次のセルに移動します。
spread.commandManager().execute({cmd: "moveToNextCell", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

moveToNextCellThenControl

moveToNextCellThenControl: Object

アクティブセルが最後の可視セルの場合は次のコントロールを選択し、それ以外の場合はアクティブセルを次のセルに移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、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キー

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

moveToPreviousCell

moveToPreviousCell: Object

アクティブセルを前のセルに移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、 moveToPreviousCell操作をマップします。
spread.commandManager().setShortcutKey('moveToPreviousCell', GC.Spread.Commands.Key.a, false, false, false, false); // a

// コマンドを呼び出して、アクティブなセルを前のセルに移動します。
spread.commandManager().execute({cmd: "moveToPreviousCell", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

moveToPreviousCellThenControl

moveToPreviousCellThenControl: Object

アクティブセルが最初の可視セルの場合は前のコントロールを選択し、それ以外の場合はアクティブセルを前のセルに移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、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キー

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationBottom: Object

アクティブセルを最後の行に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、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キー

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationDown: Object

アクティブセルを次の行に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、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キー

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationEnd: Object

アクティブセルを最後の列に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationEndメソッドを使用します。
spread.commandManager().setShortcutKey('navigationEnd', GC.Spread.Commands.Key.tab,  false, false, false, false); // Tabキー

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationEnd2: Object

固定末尾列を無視してアクティブセルを最後の列に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationEnd2操作をマップします。
spread.commandManager().setShortcutKey("navigationEnd2", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationFirst: Object

アクティブセルをシートの最初のセルに移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationFirst操作をマップします。
spread.commandManager().setShortcutKey("navigationFirst", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationHome: Object

アクティブセルを最初の列に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationHome2操作を使用します。
spread.commandManager().setShortcutKey("navigationHome", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationHome2: Object

固定列を無視してアクティブセルを最初の列に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationHome2操作をマップします。
spread.commandManager().setShortcutKey("navigationHome2", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationLast: Object

アクティブセルをシートの最後のセルに移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationLast操作をマップします。
spread.commandManager().setShortcutKey("navigationLast", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationLeft: Object

アクティブセルを前の列に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationLeft操作をマップします。
spread.commandManager().setShortcutKey("navigationLeft", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationNextSheet: Object

アクティブシートを次のシートに移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationNextSheet操作をマップします。
spread.commandManager().setShortcutKey("navigationNextSheet", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationPageDown: Object

アクティブセルを1ページ下の行に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationPageDown操作をマップします。
spread.commandManager().setShortcutKey("navigationPageDown", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationPageUp: Object

アクティブセルを1ページ上の行に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationPageUp操作をマップします。
spread.commandManager().setShortcutKey("navigationPageUp", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationPreviousSheet: Object

アクティブシートを前のシートに移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、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);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }, isUndo: boolean) => any

navigationRight: Object

アクティブセルを次の列に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationRight操作をマップします。
spread.commandManager().setShortcutKey("navigationRight", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationTop: Object

アクティブセルを最初の行に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationTop操作を使用します。
spread.commandManager().setShortcutKey("navigationTop", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

navigationUp: Object

アクティブセルを前の行に移動するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、navigationUpアクションをaにマップします。
spread.commandManager().setShortcutKey('navigationUp', GC.Spread.Commands.Key.a, false, false, false, false); // a

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

openCalculator

openCalculator: Object

指定されたセルで電卓ピッカーを開くためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シート領域。

パラメータ rowIndex。

パラメータ columnIndex。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して電卓を開きます。
spread.commandManager().execute({cmd: "openCalculator", sheetName: "Sheet1", row: 1, col: 2});

型宣言

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

openColorPicker

openColorPicker: Object

指定されたセルでカラーピッカーを開くためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シート領域。

パラメータ rowIndex。

パラメータ columnIndex。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してカラーピッカーを開きます。
spread.commandManager().execute({cmd: "openColorPicker", sheetName: "Sheet1", row: 1, col: 2});

型宣言

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

openDateTimePicker

openDateTimePicker: Object

指定されたセルで日付時刻ピッカーを開くためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シート領域。

パラメータ rowIndex。

パラメータ columnIndex。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して dateTimePicker を開きます。
spread.commandManager().execute({cmd: "openDateTimePicker", sheetName: "Sheet1", row: 1, col: 2});

型宣言

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

openList

openList: Object

指定されたセルでリストピッカーを開くためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シート領域。

パラメータ rowIndex。

パラメータ columnIndex。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してリストを開きます。
spread.commandManager().execute({cmd: "openList", sheetName: "Sheet1", row: 1, col: 2});

型宣言

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

openMonthPicker

openMonthPicker: Object

指定されたセルで月ピッカーを開くためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シート領域。

パラメータ rowIndex。

パラメータ columnIndex。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して月ピッカーを開きます。
spread.commandManager().execute({cmd: "openMonthPicker", sheetName: "Sheet1", row: 1, col: 2});

型宣言

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

openMultiColumn

openMultiColumn: Object

指定されたセルで複数列のリストピッカーを開くためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シート領域。

パラメータ rowIndex。

パラメータ columnIndex。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して MultiColumn を開きます。
spread.commandManager().execute({cmd: "openMultiColumn", sheetName: "Sheet1", row: 1, col: 2});

型宣言

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

openPasteSpecialDialog

openPasteSpecialDialog: Object

形式を選択して貼り付けダイアログを開くコマンドを表します。

パラメータ 操作のコンテキスト。

実例

// 次のサンプルコードは、形式を選択して貼り付けを開きます。
spread.commandManager().execute({cmd: "openPasteSpecialDialog", sheetName: spread.getActiveSheet().name()});

型宣言

名前
canUndo boolean
execute (context: Workbook) => void

openSlider

openSlider: Object

指定されたセルでスライダーピッカーを開くためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シート領域。

パラメータ rowIndex。

パラメータ columnIndex。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してスライダーを開きます。
spread.commandManager().execute({cmd: "openSlider", sheetName: "Sheet1", row: 1, col: 2});

型宣言

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

openTimePicker

openTimePicker: Object

指定されたセルで時刻ピッカーを開くためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シート領域。

パラメータ rowIndex。

パラメータ columnIndex。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して TimePicker を開きます。
spread.commandManager().execute({cmd: "openTimePicker", sheetName: "Sheet1", row: 1, col: 2});

型宣言

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

openUrl

openUrl: Object

ハイパーリンク付きセルのURLを開くために使用されるコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ URL文字列。

パラメータ ターゲットタイプ。デフォルトは空白です。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// クリア コマンドを呼び出してハイパーリンクセルの URL を開きます。
spread.commandManager().execute({cmd: "openUrl", sheetName: "Sheet1", url: "https://www.spreadjs.com", target: GC.Spread.Sheets.Hyperlink.HyperlinkTargetType.blank});

型宣言

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

openWorkflowList

openWorkflowList: Object

指定されたセルでワークフローリストピッカーを開くためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シート領域。

パラメータ rowIndex。

パラメータ columnIndex。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してカラーピッカーを開きます。
spread.commandManager().execute({cmd: "openWorkflowList", sheetName: "Sheet1", row: 1, col: 2});

型宣言

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

outlineColumn

outlineColumn: Object

シート上の列アウトライン(範囲グループ)をグループ化するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ アウトライン開始インデックス。

パラメータ アウトラインでグループ化またはグループ化解除する行または列の数。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、グループを作成します。
spread.options.allowUndo = true;
spread.commandManager().execute({cmd: "outlineColumn", sheetName: "Sheet1", index: 3, count: 5});

型宣言

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

outlineRow

outlineRow: Object

シート上の行アウトライン(範囲グループ)をグループ化するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ アウトライン開始インデックス。

パラメータ アウトラインでグループ化またはグループ化解除する行または列の数。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、アクションを元に戻します。
spread.options.allowUndo = true;
spread.commandManager().execute({cmd: "outlineRow", sheetName: "Sheet1", index: 3, count: 5});

型宣言

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

paste

paste: Object

クリップボードから現在のシートに選択されている項目を貼り付けるためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 挿入されたデータは、挿入された方向に移動する必要があります。

パラメータ 貼り付けのオプション。

パラメータ クリップボードのテキストを貼り付けます。

パラメータ クリップボードの HTML を貼り付けます。

パラメータ

パラメータ 貼り付け操作のオプション。

パラメータ コピーした範囲内の空白セルを、対応するセルを置換せずにスキップするかどうか。

パラメータ コピーされたデータの列を行に変更するかどうか。

パラメータ セル参照を貼り付けるかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して、選択した項目をクリップボードから現在のシートに貼り付けます。
spread.commandManager().execute({cmd: "paste", sheetName: "Sheet1", pasteText: "test"});

型宣言

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

pasteFloatingObjects

pasteFloatingObjects: Object

シートにフローティングオブジェクトを貼り付けるためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してフローティングオブジェクトを貼り付けます。
spread.commandManager().execute({cmd: "pasteFloatingObjects", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }, isUndo: boolean) => boolean

redo

redo: Object

直近のアンドゥされた編集またはアクションのリドゥを実行するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、リドゥコマンドを使用します。
spread.commandManager().execute({cmd: "redo", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

removeColumnOutline

removeColumnOutline: Object

シート上の列アウトライン(範囲グループ)をグループ化解除するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ アウトライン開始インデックス。

パラメータ アウトラインでグループ化またはグループ化解除する行または列の数。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して列アウトラインのグループを解除します。
spread.commandManager().execute({cmd: "removeColumnOutline", sheetName: "Sheet1", index: 1, count: 3});

型宣言

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

removeRowOutline

removeRowOutline: Object

シート上の行アウトライン(範囲グループ)をグループ化解除するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ アウトライン開始インデックス。

パラメータ アウトラインでグループ化またはグループ化解除する行または列の数。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して行アウトラインのグループを解除します。
spread.commandManager().execute({cmd: "removeRowOutline", sheetName: "Sheet1", index: 1, count: 3});

型宣言

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

renameSheet

renameSheet: Object

ワークシートの名前を変更するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ シートの新しい名前。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、シートの名前を変更します。
spread.commandManager().execute({cmd: "renameSheet", sheetName: "Sheet1", name: "SheetName"});

型宣言

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

resizeColumn

resizeColumn: Object

ワークシートの列をサイズ変更するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ サイズ変更する列。各要素は、firstColとlastCol を持つオブジェクトです。

パラメータ サイズ変更される列のサイズ。

パラメータ サイズ変更する列が行ヘッダ領域にあるかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して列のサイズを変更します。
spread.commandManager().execute({cmd: "resizeColumn", sheetName: "Sheet1", columns: [{firstCol: 1, lastCol: 5}], size: 200, rowHeader: false});

型宣言

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

resizeFloatingObjects

resizeFloatingObjects: Object

フローティングオブジェクトをサイズ変更するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ フローティングオブジェクトの名前の配列。

パラメータ オフセット:左。

パラメータ オフセット:上。

パラメータ オフセットの幅。

パラメータ オフセットの高さ。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してフローティングオブジェクトのサイズを変更します。
spread.commandManager().execute({cmd: "resizeFloatingObjects", sheetName: "Sheet1", floatingObjects: ["floatingObject1", "floatingObject2"], offsetWidth: 100, offsetHeight: 100});

型宣言

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

resizeRow

resizeRow: Object

ワークシートの行をサイズ変更するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ サイズ変更する行。各要素は 、firstRow とlastRowを持つオブジェクトです。

パラメータ サイズ変更される行のサイズ。

パラメータ サイズ変更する行が列ヘッダ領域にあるかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出して行のサイズを変更します。
spread.commandManager().execute({cmd: "resizeRow", sheetName: "Sheet1", rows: [{firstRow: 1, lastRow: 5}], size: 100, rowHeader: false});

型宣言

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

selectNextControl

selectNextControl: Object

次のコントロールを選択するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、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キー

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectPreviousControl

selectPreviousControl: Object

前のコントロールを選択するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、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キー

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionBottom

selectionBottom: Object

選択範囲を最後の行まで拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionBottom操作を使用します。
spread.commandManager().setShortcutKey('selectionBottom', GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionDown

selectionDown: Object

選択範囲を下に1行拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionDown操作を使用します。
spread.commandManager().setShortcutKey('selectionDown', GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionEnd

selectionEnd: Object

選択範囲を最後の列まで拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionEnd操作を使用します。
spread.focus();
spread.commandManager().setShortcutKey('selectionEnd', GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionFirst

selectionFirst: Object

選択範囲を最初のセルまで拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionFirst操作を使用します。
spread.focus();
spread.commandManager().setShortcutKey('selectionFirst', GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionHome

selectionHome: Object

選択範囲を最初の列まで拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionHome操作を使用します。
spread.focus();
spread.commandManager().setShortcutKey('selectionHome', GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionLast

selectionLast: Object

選択範囲を最後のセルまで拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionLast操作を使用します。
spread.focus();
spread.commandManager().setShortcutKey('selectionLast', GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionLeft

selectionLeft: Object

選択範囲を左に1列拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionLeft操作を使用します。
spread.commandManager().setShortcutKey('selectionLeft', GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }, isUndo: boolean) => any

selectionPageDown

selectionPageDown: Object

選択範囲を1ページ分下の行まで拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionPageDown操作を使用します。
spread.commandManager().setShortcutKey('selectionPageDown', GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionPageUp

selectionPageUp: Object

選択範囲を1ページ分上の行まで拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionPageUp操作を使用します。
spread.commandManager().setShortcutKey('selectionPageUp', GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionRight

selectionRight: Object

選択範囲を右に1列拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionRight操作を使用します。
spread.commandManager().setShortcutKey("selectionRight", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionTop

selectionTop: Object

選択範囲を最初の行まで拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionTop操作を使用します。
spread.commandManager().setShortcutKey("selectionTop", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

selectionUp

selectionUp: Object

選択範囲を上に1行拡張するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、selectionUp操作を使用します。
spread.commandManager().setShortcutKey("selectionUp", GC.Spread.Commands.Key.a, false, false, false, false);

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

splitResizeColumn

splitResizeColumn: Object

ワークシートの列を分割サイズするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ サイズ変更する列。各要素は、firstColとlastCol を持つオブジェクトです。

パラメータ サイズ変更される列のサイズ。

パラメータ サイズ変更する列が行ヘッダ領域にあるかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してサイズ変更された列を分割します。
spread.commandManager().execute({cmd: "splitResizeColumn", sheetName: "Sheet1", columns: [{firstCol: 1, lastCol: 2}]}, size: 100, rowHeader: false);

型宣言

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

splitResizeRow

splitResizeRow: Object

ワークシートの行を分割とリサイズするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ サイズ変更する行。各要素は 、firstRow とlastRowを持つオブジェクトです。

パラメータ サイズ変更される行のサイズ。

パラメータ サイズ変更する行が列ヘッダ領域にあるかどうか。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してサイズ変更された行を分割します。
spread.commandManager().execute({cmd: "splitResizeRow", sheetName: "Sheet1", rows: [{firstRow: 1, lastRow: 2}]}, size: 100, columnHeader: false);

型宣言

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

tableDeleteColumns

tableDeleteColumns: Object

テーブルの列を削除するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ テーブル名。

パラメータ テーブルのインデックスに基づいて削除する最初列のインデックス。

パラメータ 削除する列数。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してテーブルの列を削除します。
spread.commandManager().execute({cmd: "tableDeleteColumns", sheetName: "Sheet1", tableName: "table1", col: 1, count: 3});

型宣言

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

tableDeleteRows

tableDeleteRows: Object

テーブルの行を削除するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ テーブル名。

パラメータ テーブルのインデックスに基づいて削除する最初行のインデックス。

パラメータ 削除する行数。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してテーブルの行を削除します。
spread.commandManager().execute({cmd: "tableDeleteRows", sheetName: "Sheet1", tableName: "table1", row: 1, count: 3});

型宣言

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

tableInsertColumns

tableInsertColumns: Object

テーブルの列を挿入するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ テーブル名。

パラメータ テーブルのインデックスに基づいて削除する最初列のインデックス。

パラメータ 挿入する列数。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してテーブルの列を挿入します。
spread.commandManager().execute({cmd: "tableInsertColumns", sheetName: "Sheet1", tableName: "table1", col: 1, count: 3});

型宣言

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

tableInsertRows

tableInsertRows: Object

テーブルの行を挿入するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ テーブル名。

パラメータ テーブルのインデックスに基づいて挿入する最初行のインデックス。

パラメータ 挿入する行数。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してテーブルの行を挿入します。
spread.commandManager().execute({cmd: "tableInsertRows", sheetName: "Sheet1", tableName: "table1", row: 1, count: 3});

型宣言

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

tableResize

tableResize: Object

テーブルのサイズ変更するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ テーブル名。

パラメータ サイズ変更されたテーブル範囲。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してテーブルのサイズを変更します。
spread.commandManager().execute({cmd: "tableResize", sheetName: "Sheet1", tableName: "table1", resizeToRange: new GC.Spread.Sheets.Range(1, 1, 5, 3)});

型宣言

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

undo

undo: Object

直近の編集またはアクションのアンドゥを実行するためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// 次のサンプルコードは、アンドゥコマンドを使用します。
spread.commandManager().execute({cmd: "undo", sheetName: "Sheet1"});

型宣言

名前
canUndo boolean
execute (context: Workbook, options: { sheetName: string }) => any

zoom

zoom: Object

シートをズームするためのコマンドを表します。

プロパティ canUndo - コマンドがアンドゥおよびリドゥ操作をサポートするかどうかを示します。

プロパティ execute - 実行操作またはアンドゥ操作を実行します。executeメソッドの引数は次のとおりです。

パラメータ 操作のコンテキスト。

パラメータ 操作のオプション。

パラメータ シート名。

パラメータ ズーム率。

パラメータ 操作がアンドゥである場合はtrue、それ以外の場合はfalse

実例

// コマンドを呼び出してシートをズームします。
spread.commandManager().execute({cmd: "zoom", sheetName: "Sheet1", zoomFactor: 3});

型宣言

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

関数

endTransaction

endTransaction(context, options): void

トランザクションを終了します。 トランザクション中に、データモデルの変更が保存されます。

実例

//たとえば、次のサンプルコードは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"});

パラメータ

名前 説明
context Workbook 操作のコンテキスト。
options any 操作のオプション。

戻り値

void


startTransaction

startTransaction(context, options): void

トランザクションを開始します。 トランザクション中に、データモデルの変更が保存されます。

実例

//たとえば、次のサンプルコードは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"});

パラメータ

名前 説明
context Workbook 操作のコンテキスト。
options any 操作のオプション。

戻り値

void


undoTransaction

undoTransaction(context, options): void

トランザクションの変更をアンドゥします。

実例

//たとえば、次のサンプルコードは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"});

パラメータ

名前 説明
context Workbook 操作のコンテキスト。
options any 操作のオプション。

戻り値

void