- Preparing search index...
- The search index is not available
UndoStack Class
Heirarchy
- UndoStack
Constructors
Properties
Methods
Events
Constructors
constructor
-
Initializes a new instance of the UndoStack class.
Parameters
-
Optional target: any
The DOM element or CSS selector for the DOM elements to be added to UndoStack context. If not provided, the whole document body is added to the context.
-
Optional options: any
The JavaScript object containing initialization data for the UndoStack.
Returns UndoStack
-
Properties
actionCount
Gets the number of actions currently stored in the UndoStack.
autoKeyboard
Gets or sets a value that determines whether the UndoStack should monitor the keyboard and handle the undo/redo keys (ctrl+Z/ctrl+Y) automatically.
canRedo
Gets a value that determines whether the UndoStack is ready to redo an action.
canUndo
Gets a value that determines whether the UndoStack is ready to undo an action.
isDisabled
Gets or sets a vlue that determines whether the UndoStack is currently disabled.
maxActions
Gets or sets the maximum number of actions to store in the UndoStack.
The default value for this property is 1,000 actions.
Methods
addTarget
clear
-
Clears the UndoStack.
Returns void
onAddedAction
-
Raises the addedAction event.
Parameters
-
e: UndoActionEventArgs
UndoActionEventArgs that contains the event data.
Returns void
-
onAddedTarget
-
Raises the {link @addedTarget} event.
Parameters
-
e: AddTargetEventArgs
AddTargetEventArgs that contains the event data.
Returns void
-
onAddingAction
-
Raises the addingAction event.
Parameters
-
e: UndoActionEventArgs
UndoActionEventArgs that contains the event data.
Returns boolean
True if the event was not canceled.
-
onAddingTarget
-
Raises the addingTarget event.
Parameters
-
e: AddTargetEventArgs
AddTargetEventArgs that contains the event data.
Returns boolean
True if the event was not canceled.
-
onRedoingAction
-
Raises the redoingAction event.
Parameters
-
e: UndoActionEventArgs
UndoActionEventArgs that contains the event data.
Returns boolean
True if the event was not canceled.
-
onRedoneAction
-
Raises the redoneAction event.
Parameters
-
e: UndoActionEventArgs
UndoActionEventArgs that contains the event data.
Returns void
-
onStateChanged
-
Raises the stateChanged event.
Returns void
onUndoingAction
-
Raises the undoingAction event.
Parameters
-
e: UndoActionEventArgs
UndoActionEventArgs that contains the event data.
Returns boolean
True if the event was not canceled.
-
onUndoneAction
-
Raises the undoneAction event.
Parameters
-
e: UndoActionEventArgs
UndoActionEventArgs that contains the event data.
Returns void
-
pushAction
-
Pushes a new undoable action onto the stack.
Parameters
-
action: UndoableAction
UndoableAction to add to the stack.
Returns void
-
redo
-
Redoes the last action undone.
Returns void
undo
-
Undoes the last action recorded.
Returns void
Events
addedAction
Occurs after an UndoableAction had been added to the stack.
addedTarget
Occurs after an element has been added to the UndoStack context.
addingAction
Occurs when an UndoableAction is about to be added to the stack.
addingTarget
Occurs when an element is about to be added to the UndoStack context.
Listeners may prevent the element from being added to the context by setting the cancel parameter to true.
redoingAction
Occurs when an UndoableAction is about to be redone.
redoneAction
Occurs after an UndoableAction has been redone.
stateChanged
undoingAction
Occurs when an UndoableAction is about to be undone.
undoneAction
Occurs after an UndoableAction has been undone.
Class that provides undo/redo functionality for input elements and Wijmo controls.