register メソッド

コマンドをコマンドマネージャに登録します。

シンタックス

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Commands.CommandManager(context);
var value; // Type: any

// パラメータ
var name; //タイプ： string
var command; //タイプ： Object
var key; //タイプ： undefined
var ctrl; //タイプ： boolean
var shift; //タイプ： boolean
var alt; //タイプ： boolean
var meta; //タイプ： boolean

value = instance.register(name, command, key, ctrl, shift, alt, meta);

function register( 
   name : string,
   command : Object,
   key : undefined,
   ctrl : boolean,
   shift : boolean,
   alt : boolean,
   meta : boolean
) : any;

パラメータ

name: - コマンドの名前。
command: - コマンドを定義するオブジェクト。
key: - キーコード。
ctrl: - コマンドが［Ctrl］キーを使用する場合はtrue、それ以外の場合はfalse。
shift: - コマンドが［Shift］キーを使用する場合はtrue、それ以外の場合はfalse。
alt: - コマンドが［Alt］キーを使用する場合はtrue、それ以外の場合はfalse。
meta: - コマンドがコマンドキー（Macintoshの場合）またはWindowsキー（Microsoft Windowsの場合）を使用する場合はtrue、それ以外の場合はfalse。

使用例

Javascript

// たとえば、次のサンプルコードはchangeBackColorコマンドを登録してから、そのコマンドを実行します。 var command = { canUndo: true, execute: function (context, options, isUndo) { var Commands = GC.Spread.Sheets.Commands; if (isUndo) { Commands.undoTransaction(context, options); return true; } else { Commands.startTransaction(context, options); var sheet = context.getSheetFromName(options.sheetName); var cell = sheet.getCell(options.row, options.col); cell.backColor(options.backColor); Commands.endTransaction(context, options); return true; } } }; var spread = GC.Spread.Sheets.findControl(document.getElementById("ss")); var commandManager = spread.commandManager(); commandManager.register("changeBackColor", command); commandManager.execute({cmd: "changeBackColor", sheetName: spread.getSheet(0).name(), row: 1, col: 2, backColor: "red"});

参照

CommandManager クラス