Skip to main content

History Class

Contains methods related to Rich Text Editor history.

Declaration

export class History

Remarks

An object of the History class can be accessed by the history property.

richEdit.history.undo();

Methods

beginTransaction Method

Specifies that the following actions should be saved as a single history transaction.

Declaration

beginTransaction(): void

Remarks

Use the beginTransaction and endTransaction methods to process several actions as a single history transaction.

richEdit.beginUpdate();
richEdit.history.beginTransaction();
var subDocument = richEdit.selection.activeSubDocument;
var position = richEdit.selection.active;
var columnCount = 5;
var rowCount = 5;
var table = subDocument.tables.create(position, columnCount, rowCount);
for (var rowInd = 0, row; row = table.rows.getByIndex(rowInd); rowInd++) {
    for (var cellInd = 0, cell; cell = row.cells.getByIndex(cellInd); cellInd++) {
        subDocument.insertText(cell.interval.start, "Row[" + rowInd + "].Cell[" + cellInd + "]");
    }
}
richEdit.history.endTransaction();
richEdit.endUpdate();

clear Method

Clears the editor history.

Declaration

clear(): void

endTransaction Method

Ends a history transaction.

Declaration

endTransaction(): void

Remarks

Use the beginTransaction and endTransaction methods to process several actions as a single history transaction.

redo Method

Redoes the last undone action in the Rich Text Editor.

Declaration

redo(): void

Remarks

richEdit.history.redo();

undo Method

Undoes the last action in the Rich Text Editor.

Declaration

undo(): void

Remarks

richEdit.history.undo();