Skip to main content

beforeRowDelete

caution

The beforeRowDelete 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 === "deleteRow") {
        console.log(actionName, config);
        return false;
    }
});

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

Description​

Fires before a row is deleted

Usage​

beforeRowDelete: (cell: string) => void | boolean;

Parameters​

The callback of the event takes the following parameters:

  • cell - (required) the id of a cell

Returns​

Return true to delete a row, false to prevent deleting of a row

Example​

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

// subscribe on the "beforeRowDelete" event
spreadsheet.events.on("beforeRowDelete", function(cell){
    console.log("A row will be deleted");
    console.log(cell);
    return true;
});

Related articles: Event handling