fires before a sheet is removed

boolean BeforeSheetRemove(object sheet){ ... };


sheetobjectthe object of a sheet


booleantrue to remove a sheet, false to prevent removing of a sheet

Example"beforeSheetRemove", function(sheet) {
    console.log("The ",, " sheet will be removed");
    return true;


The sheet object contains the following parameters:

  • name - (string) the name of the sheet to be deleted
  • id - (string) the id of the sheet to be deleted

The event is blockable, returning false will prevent removing of a sheet.

Change log

added in v4.1

Back to top