Skip to main content

beforeSheetAdd

caution

The beforeSheetAdd event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach:

spreadsheet.events.on("beforeAction", (actionName, config) => {
    if (actionName === "addSheet") {
        console.log(actionName, config);
        return false;
    }
});

For more details about the new concept, see Spreadsheet actions.

Description​

Fires before a new sheet is added

Usage​

beforeSheetAdd: (name: string) => void | boolean;

Parameters​

The callback of the event takes the following parameters:

  • name - (required) the name of the new sheet

Returns​

Return true to add a sheet, false to prevent adding of a sheet

Example​

const spreadsheet = new dhx.Spreadsheet("spreadsheet", {});
spreadsheet.parse(data);

// subscribe on the "beforeSheetAdd" event
spreadsheet.events.on("beforeSheetAdd", function(name) {
    console.log("A new sheet will be added");
    console.log(name);
    return true;
});

Changelog: Added in v4.1

Related articles: Event handling