Name | Description | |
---|---|---|
NHistoryService Constructor | Initializer constructor |
The following tables list the members exposed by NHistoryService.
Name | Description | |
---|---|---|
NHistoryService Constructor | Initializer constructor |
Name | Description | |
---|---|---|
NHistoryServiceSchema | Schema associated with NHistoryService | |
RedoExecutedEvent | Reference to the RedoExecuted event | |
TransactionCommitedEvent | Reference to the TransactionRolledback event | |
TransactionRolledbackEvent | Reference to the TransactionRolledback event | |
TransactionStartedEvent | Reference to the TransactionStarted event | |
UndoExecutedEvent | Reference to the UndoExecuted event | |
UnitRecordedEvent | Reference to the UnitRecorded event |
Name | Description | |
---|---|---|
IsRedoing | Determines whether the history service is currently redoing an unit | |
IsUndoing | Determines whether the history service is currently undoing an unit | |
IsUndoingOrRedoing | Determines whether the history service is currently undoing or redoing an unit | |
MaxUndoLevels | Controls the max depth of the undo stack. Setting this property will automatically clear the extra units in the undo stack. By default set to 100. | |
OwnerDocument | Gets the resolving document. The resolving document is the root document monitored by this history service. | |
RedoStack | Gets the Redo units stack | |
TransactionStack | Gets the Transaction units stack | |
UndoStack | Gets the Undo units stack | |
UndoStackDepth | The current undo stack depth. Note that this value may be different than the count of items in the UndoStack, since the UndoStack depth cannot exceed MaxUndoLevels. |
Name | Description | |
---|---|---|
CanRecord | Determines whether a new unit can be recorded. The history cannot record any unit if it is not in started state, or is currently undoing or redoing an unit. | |
CanRedo | Determines whether the user can perform Redo. | |
CanUndo | Determines whether the user can perform Undo. | |
CommitTransaction | Commits the last started transaction. | |
DumpRedoStackToObjectsList | ||
DumpToListBoxes | Dumps the state of the undo and redo stacks in the specified ListBox instances. | |
DumpToTreeViews | Dumps the state of the undo and redo stacks in the specified TreeView instances. | |
DumpUndoStackToObjectsList | ||
Record | Records the specified unit. If there are no started transactions, the unit is pushed in the undo stack and the redo stack is cleared. It there is a started transaction, the unit is appended as a child unit of the transaction unit. | |
Redo | Redoes the peak unit from the redo stack and pushes in the undo stack. | |
RollbackTransaction | Rolls back the currently started transaction and undoes the effect of the units recorded in it. | |
StartTransaction | Overloaded. Starts a new history transaction. Transactions are units, which are pushed in the transaction stack and their recording is suspended until the CommitTransaction method is called. | |
Undo | Undoes the peak unit from the undo stack and pushes in the redo stack. |
Name | Description | |
---|---|---|
OnRedoExecuted | Called when an unit has been successfully redone | |
OnStoped | Overridden. Overriden to clear the state of the history service | |
OnTransactionCommited | Called when a transaction has been commited | |
OnTransactionRolledback | Called when the last started transaction has been rolled back | |
OnTransactionStarted | Called when a transaction has been started | |
OnUndoExecuted | Called when an unit has been successfully undone | |
OnUnitRecorded | Called whenever an unit has been recored in the undo stack |
Name | Description | |
---|---|---|
RedoExecuted | Occurs when redo is executed | |
TransactionCommited | Occurs when a transaction has been commited | |
TransactionRolledback | Occurs when a transaction has been rolled back | |
TransactionStarted | Occurs when a transaction has been started | |
UndoExecuted | Occurs when undo is executed | |
UnitRecorded | Occurs when a new unit has been recorded |