Skip to main content

beforeBlockSelectionApply

pro version only

This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.

triggered before applying the selection (e.g., to a range)

Usage​

beforeBlockSelectionApply: (
    startCell: { row: object; column: object },
    endCell: { row: object; column: object },
    handle: boolean,
    event: MouseEvent | TouchEvent
) => boolean | void;

Parameters:

The callback of the event is called with the following parameters:

startCell(object) an object that contains the initial cell of the selection, includes the following properties:
  • row - (object) the row configuration object
  • column - (object) the column configuration object
endCell(object) an object that contains the end cell of the selection, includes the following properties:
  • row - (object) the row configuration object
  • column - (object) the column configuration object
handle(boolean) indicates whether the handle was used (true) or a regular selection (false)
event(Event) the browser event: MouseEvent or TouchEvent

Returns:

Return false to cancel the action; otherwise, true.

Example

grid.block.events.on("beforeBlockSelectionApply", (startCell, endCell) => {
    if (endCell.row.id === "2") {
        console.log("Application canceled if the range ends with row 2");
        return false;
    }
});

Change log:

added in v9.2