UndoRedoExtension Class

A Web Dashboard extension that allows you to keep track of all user actions, and cancel or repeat them.

Declaration

export class UndoRedoExtension extends DisposableObject

Implements

IDisposable

Inherited Members

dispose

Inheritance

DisposableObject

UndoRedoExtension

constructor(dashboardControl)

Initializes a new instance of the UndoRedoExtension class.

Declaration

constructor(
    dashboardControl: DashboardControl
)

Parameters

Name	Type	Description
dashboardControl	DashboardControl	A Web Dashboard control that owns the extension.

Properties

isChanged Property

Specifies whether the Web Dashboard has unsaved changes.

Declaration

isChanged: ko.Computed<boolean>

Property Value

Type	Description
Computed<boolean>	true, if the dashboard has unsaved changes; otherwise, false.

name Property

Specifies a unique extension name.

Declaration

name: string

Property Value

Type	Description
string	A unique extension name. The return value is ‘undo-redo’.

Remarks

Warning

Do not change a unique name of the extension registered in the Web Dashboard in order to avoid exceptions.

Methods

processKeyEvent(keyEventType, eventArgs) Method

Allows you to process which key was pressed.

Declaration

processKeyEvent(
    keyEventType: KeyEventType,
    eventArgs: JQueryKeyEventObject
): boolean

Parameters

Name	Type	Description
keyEventType	KeyEventType	The KeyEventType object that identifies a user interaction with the keyboard.
eventArgs	JQueryKeyEventObject	A JQueryKeyEventObject object that identifies a key.

Returns

Type	Description
boolean	true, if a key used to undo the operation; otherwise, false.

redo Method

Declaration

redo(): void

redoEnabled Method

Declaration

redoEnabled(): boolean

Returns

Type
boolean

reset Method

Declaration

reset(): void

start Method

Contains code that is executed when you register the dashboard extension.

Declaration

start(): void

stop Method

Contains code that is executed when you unregister the dashboard extension.

Declaration

stop(): void

undo Method

Declaration

undo(): void

undoEnabled Method

Declaration

undoEnabled(): boolean

Returns

Type
boolean