NevronOpenVision
Nevron.Nov.Dom Namespace / NHistoryService Class
Fields Properties Methods Events


In This Topic
    NHistoryService Class Members
    In This Topic

    The following tables list the members exposed by NHistoryService.

    Public Constructors
     NameDescription
    Public ConstructorInitializer constructor  
    Top
    Public Fields
     NameDescription
    Public Fieldstatic (Shared in Visual Basic)Schema associated with NHistoryService  
    Public Fieldstatic (Shared in Visual Basic)Reference to the RedoExecuted event  
    Public Fieldstatic (Shared in Visual Basic)Reference to the TransactionRolledback event  
    Public Fieldstatic (Shared in Visual Basic)Reference to the TransactionRolledback event  
    Public Fieldstatic (Shared in Visual Basic)Reference to the TransactionStarted event  
    Public Fieldstatic (Shared in Visual Basic)Reference to the UndoExecuted event  
    Public Fieldstatic (Shared in Visual Basic)Reference to the UnitRecorded event  
    Top
    Protected Fields
     NameDescription
    Internal Field  
    Internal Field  
    Internal Field  
    Internal Field  
    Internal Field  
    Internal Field  
    Internal Field  
    Internal Field  
    Top
    Public Properties
     NameDescription
    Public PropertyDetermines whether the history service is currently redoing an unit  
    Public PropertyDetermines whether the history service is currently undoing an unit  
    Public PropertyDetermines whether the history service is currently undoing or redoing an unit  
    Public PropertyControls 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.  
    Public PropertyGets the resolving document. The resolving document is the root document monitored by this history service.  
    Public PropertyGets the Redo units stack  
    Public PropertyGets the Transaction units stack  
    Public PropertyGets the Undo units stack  
    Public PropertyThe 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.  
    Top
    Public Methods
     NameDescription
    Public MethodDetermines 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.  
    Public MethodDetermines whether the user can perform Redo.  
    Public MethodDetermines whether the user can perform Undo.  
    Public MethodCommits the last started transaction.  
    Public Method  
    Public MethodDumps the state of the undo and redo stacks in the specified ListBox instances.  
    Public MethodDumps the state of the undo and redo stacks in the specified TreeView instances.  
    Public Method  
    Public MethodRecords 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.  
    Public MethodRedoes the peak unit from the redo stack and pushes in the undo stack.  
    Public MethodRolls back the currently started transaction and undoes the effect of the units recorded in it.  
    Public MethodOverloaded. 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.  
    Public MethodUndoes the peak unit from the undo stack and pushes in the redo stack.  
    Top
    Protected Methods
     NameDescription
    Protected MethodCalled when an unit has been successfully redone  
    Protected MethodOverridden. Overriden to clear the state of the history service  
    Protected MethodCalled when a transaction has been commited  
    Protected MethodCalled when the last started transaction has been rolled back  
    Protected MethodCalled when a transaction has been started  
    Protected MethodCalled when an unit has been successfully undone  
    Protected MethodCalled whenever an unit has been recored in the undo stack  
    Top
    Public Events
     NameDescription
    Public EventOccurs when redo is executed  
    Public EventOccurs when a transaction has been commited  
    Public EventOccurs when a transaction has been rolled back  
    Public EventOccurs when a transaction has been started  
    Public EventOccurs when undo is executed  
    Public EventOccurs when a new unit has been recorded  
    Top
    See Also