Class: CommandManager

Spread.Commands.CommandManager

Table of contents

Constructors

• constructor

Methods

• execute
• register
• setShortcutKey

Constructors

constructor

• new CommandManager(context)

Represents a command manager.

Parameters

Methods

execute

▸ execute(commandOptions): boolean

Executes a command and adds the command to UndoManager.

example

//For example, the following code executes the autoFitColumn command.
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});

Parameters

Returns

boolean

The execute command result.

register

▸ register(name, command, key?, ctrl?, shift?, alt?, meta?): void

Registers a command with the command manager.

example

//For example, the following code registers the changeBackColor command and then executes the command.
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

Returns

void

setShortcutKey

▸ setShortcutKey(commandName, key?, ctrl?, shift?, alt?, meta?): void

Binds a shortcut key to a command.

example

//This example changes the behavior of default keys.
var activeSheet = spread.getActiveSheet();
//Change the default Up arrow key action to "Page Up" for the active cell.
spread.commandManager().setShortcutKey('navigationPageUp', GC.Spread.Commands.Key.up, false, false, false, false);
//Change the default Down arrow key action to "Page Down" for the active cell.
spread.commandManager().setShortcutKey('navigationPageDown', GC.Spread.Commands.Key.down, false, false, false, false);

Parameters

Returns

void