[]
Spread.Commands.CommandManager
• new CommandManager(context
)
コマンドマネージャを表します。
名前 | 型 | 説明 |
---|---|---|
context |
Object |
コマンドマネージャで管理されているすべてのコマンドの実行コンテキスト。 |
▸ execute(commandOptions
): boolean
コマンドを実行し、そのコマンドをUndoManagerに追加します。
実例
//たとえば、次のサンプルコードはautoFitColumnコマンドを実行します。
var spread = GC.Spread.Sheets.findControl(document.getElementById("ss"));
spread.commandManager().execute({cmd: "autoFitColumn", sheetName: "Sheet1", columns: [{col: 1}], rowHeader: false, autoFitType: GC.Spread.Sheets.AutoFitType.cell});
名前 | 型 | 説明 |
---|---|---|
commandOptions |
Object |
コマンドのオプション。 |
boolean
コマンド実行結果。
▸ register(name
, command
, key?
, ctrl?
, shift?
, alt?
, meta?
): 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"});
名前 | 型 | 説明 |
---|---|---|
name |
string |
コマンドの名前。 |
command |
Object |
コマンドを定義するオブジェクト。 |
key? |
number |
キーコード。 |
ctrl? |
boolean |
コマンドが[Ctrl]キーを使用する場合はtrue 、それ以外の場合はfalse 。 |
shift? |
boolean |
コマンドが[Shift]キーを使用する場合はtrue 、それ以外の場合はfalse 。 |
alt? |
boolean |
コマンドが[Alt]キーを使用する場合はtrue 、それ以外の場合はfalse 。 |
meta? |
boolean |
コマンドがコマンドキー(Macintoshの場合)またはWindowsキー(Microsoft Windowsの場合)を使用する場合はtrue 、それ以外の場合はfalse 。 |
void
▸ setShortcutKey(commandName
, key?
, ctrl?
, shift?
, alt?
, meta?
): void
ショートカットキーをコマンドに連結します。
実例
// 次のサンプルコードは、デフォルトキーの動作を変更します。
var activeSheet = spread.getActiveSheet();
// [↑]キーのデフォルトの動作をアクティブセルの「PageUp」に変更します。
spread.commandManager().setShortcutKey('navigationPageUp', GC.Spread.Commands.Key.up, false, false, false, false);
// [↓]キーのデフォルトの動作をアクティブセルの「PageDown」に変更します。
spread.commandManager().setShortcutKey('navigationPageDown', GC.Spread.Commands.Key.down, false, false, false, false);
名前 | 型 | 説明 |
---|---|---|
commandName |
string |
コマンド名。commandNameをundefinedに設定すると、指定したショートカットキーの連結コマンドが解除されます。 |
key? |
number |
キーコード。キーコードをundefinedに設定すると、指定したコマンドのショートカットキーが解除されます。 |
ctrl? |
boolean |
コマンドが[Ctrl]キーを使用する場合はtrue 、それ以外の場合はfalse 。 |
shift? |
boolean |
コマンドが[Shift]キーを使用する場合はtrue 、それ以外の場合はfalse 。 |
alt? |
boolean |
コマンドが[Alt]キーを使用する場合はtrue 、それ以外の場合はfalse 。 |
meta? |
boolean |
コマンドがコマンドキー(Macintoshの場合)またはWindowsキー(Microsoft Windowsの場合)を使用する場合はtrue 、それ以外の場合はfalse 。 |
void