Skip to main content

onBeforeUndoStack

Description​

Fires before an action is added into the undo stack

onBeforeUndoStack: (action: UndoRedoAction) => boolean;

Parameters​

  • action - (required) UndoRedoAction - a user action as an array of command objects

Returns​

  • result - (boolean) - defines whether the default action of the event will be triggered (true) or canceled (false)

Example​

gantt.attachEvent("onBeforeUndoStack",function(action){
    // your code here
    return true;
});

Details​

note

This event is defined in the undo extension, so you need to enable the undo plugin. Read the details in the Undo/Redo Functionality article.

  • The event is blockable, returning false will cancel further processing.
  • If the event is blocked, the undo won't capture actions from event arguments.
  • Event actions can be modified.

Change log​

  • added in version 5.2