Skip to content

spreadsheet_beforeclear_event.md

Latest commit

 

History

History
53 lines (38 loc) · 1.32 KB

spreadsheet_beforeclear_event.md

File metadata and controls

53 lines (38 loc) · 1.32 KB
Raw
sidebar_label beforeClear
title beforeClear event
description You can learn about the beforeClear event in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.

beforeClear

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

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

Description

@short: Fires before a spreadsheet is cleared

Usage

beforeClear: () => void | boolean;

Returns

Return false to prevent clearing a spreadsheet; otherwise, true.

Example

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

// subscribe on the "beforeClear" event
spreadsheet.events.on("beforeClear", function(){
    console.log("A spreadsheet will be cleared");
    return false;
});

Changelog: Added in v4.2

Related articles: Event handling