DefaultUnDo.md

DefaultUnDo

DefaultUnDo Assembly

This is the full API documentation of DefaultUnDo.

Namespaces

DefaultUnDo Namespace

• CollectionUnDo<T> Class Provides an implementation of the IUnDo interface for System.Collections.Generic.ICollection<> operation.
  • CollectionUnDo(object, ICollection<T>, T, bool) Constructor Initialise an instance of CollectionUnDo<T>.
  • CollectionUnDo(ICollection<T>, T, bool) Constructor Initialise an instance of CollectionUnDo<T>.
  • DefaultUnDo.IUnDo.Description Explicit Interface Implementation Gets a description of what this IUnDo perform.
  • DefaultUnDo.IUnDo.Do() Explicit Interface Implementation Does an action.
  • DefaultUnDo.IUnDo.Undo() Explicit Interface Implementation Does the opposite of the Do() action.
• DictionaryUnDo<TKey,TValue> Class Provides an implementation of the IUnDo interface for System.Collections.Generic.IDictionary<> operation.
  • DictionaryUnDo(object, IDictionary<TKey,TValue>, TKey, TValue, bool) Constructor Initialise an instance of DictionaryUnDo<TKey,TValue>.
  • DictionaryUnDo(IDictionary<TKey,TValue>, TKey, TValue, bool) Constructor Initialise an instance of DictionaryUnDo<TKey,TValue>.
  • DefaultUnDo.IUnDo.Description Explicit Interface Implementation Gets a description of what this IUnDo perform.
  • DefaultUnDo.IUnDo.Do() Explicit Interface Implementation Does an action.
  • DefaultUnDo.IUnDo.Undo() Explicit Interface Implementation Does the opposite of the Do() action.
• GroupUnDo Class Provides an implementation of the IUnDo interface for a group of operations.
  • GroupUnDo(IUnDo[]) Constructor Initialise an instance of GroupUnDo.
  • GroupUnDo(object, IUnDo[]) Constructor Initialise an instance of GroupUnDo.
  • MergeDescriptionAction Property The MergeDescriptionHandler(object, object, object) used to merge description between a GroupUnDo and a IMergeableUnDo instances.
  • TryGetSingle<T>(T) Method Gets the single T of this instance.
  • DefaultUnDo.IMergeableUnDo.TryMerge(IUnDo, IUnDo) Explicit Interface Implementation Merges the current instance with the specified IUnDo.
  • DefaultUnDo.IUnDo.Description Explicit Interface Implementation Gets a description of what this IUnDo perform.
  • DefaultUnDo.IUnDo.Do() Explicit Interface Implementation Does an action.
  • DefaultUnDo.IUnDo.Undo() Explicit Interface Implementation Does the opposite of the Do() action.
• ICollectionExtension Class Provides a method to wrap an System.Collections.Generic.ICollection<> to an UnDo collection linked to an IUnDoManager to automatically generate IUnDo operations.
  • AsUnDo<T>(this ICollection<T>, IUnDoManager, Func<UnDoCollectionOperation,object>) Method Wraps an System.Collections.Generic.ICollection<> to an UnDo collection linked to an IUnDoManager to automatically generate IUnDo operations.
• IDictionaryExtension Class Provides a method to wrap an System.Collections.Generic.IDictionary<> to an UnDo dictionary linked to an IUnDoManager to automatically generate IUnDo operations.
  • AsUnDo<TKey,TValue>(this IDictionary<TKey,TValue>, IUnDoManager, Func<UnDoCollectionOperation,object>) Method Wraps an System.Collections.Generic.IDictionary<> to an UnDo dictionary linked to an IUnDoManager to automatically generate IUnDo operations.
• IListExtension Class Provides a method to wrap an System.Collections.Generic.IList<> to an UnDo list linked to an IUnDoManager to automatically generate IUnDo operations.
  • AsUnDo<T>(this IList<T>, IUnDoManager, Func<UnDoCollectionOperation,object>) Method Wraps an System.Collections.Generic.IList<> to an UnDo list linked to an IUnDoManager to automatically generate IUnDo operations.
  • Move<T>(this IList<T>, int, int) Method Moves the item at the specified index to a new location in the collection.
    If source is an UnDo list and its inner source an System.Collections.ObjectModel.ObservableCollection<>, it will use the System.Collections.ObjectModel.ObservableCollection<>.Move(System.Int32,System.Int32) method;
    else it will do an System.Collections.Generic.IList<>.RemoveAt(System.Int32) and System.Collections.Generic.IList<>.Insert(System.Int32,@0).
• ISetExtension Class Provides a method to wrap an System.Collections.Generic.ISet<> to an UnDo set linked to an IUnDoManager to automatically generate IUnDo operations.
  • AsUnDo<T>(this ISet<T>, IUnDoManager, Func<UnDoCollectionOperation,object>) Method Wraps an System.Collections.Generic.ISet<> to an UnDo set linked to an IUnDoManager to automatically generate IUnDo operations.
• IUnDoManagerExtension Class Provides methods to create IUnDo command and add them to an IUnDoManager.
  • Do(this IUnDoManager, Action, Action, object) Method Does a IUnDo operation on the manager with the specified doAction and undoAction.
  • Do<T>(this IUnDoManager, Action<T>, T, T, object) Method Sets a value as a IUnDo operation.
  • Do<T>(this IUnDoManager, IList<T>, int, T, object) Method Sets the element at the specified index on a System.Collections.Generic.IList<> as a IUnDo operation.
  • Do<TKey,TValue>(this IUnDoManager, IDictionary<TKey,TValue>, TKey, TValue, object) Method Sets the element with the specified key on a System.Collections.Generic.IDictionary<> as a IUnDo operation.
  • DoAdd<T>(this IUnDoManager, ICollection<T>, T, object) Method Adds a value to a System.Collections.Generic.ICollection<> as a IUnDo operation.
  • DoAdd<T>(this IUnDoManager, ISet<T>, T, object) Method Adds an item from a System.Collections.Generic.ISet<> as a IUnDo operation.
  • DoAdd<TKey,TValue>(this IUnDoManager, IDictionary<TKey,TValue>, TKey, TValue, object) Method Adds a value to a System.Collections.Generic.IDictionary<> as a IUnDo operation.
  • DoClear<T>(this IUnDoManager, ICollection<T>, object) Method Clears a System.Collections.Generic.ICollection<> as a IUnDo operation.
  • DoInsert<T>(this IUnDoManager, IList<T>, int, T, object) Method Inserts an item to a System.Collections.Generic.IList<> at the specified index as a IUnDo operation.
  • DoOnDo(this IUnDoManager, Action, object) Method Does a IUnDo operation on the manager with the specified action with no undo.
  • DoOnUndo(this IUnDoManager, Action, object) Method Does a IUnDo operation on the manager with the specified action with no do.
  • DoRemove<T>(this IUnDoManager, ICollection<T>, T, object) Method Removes an item from a System.Collections.Generic.ICollection<> as a IUnDo operation.
  • DoRemove<TKey,TValue>(this IUnDoManager, IDictionary<TKey,TValue>, TKey, object) Method Removes the item with the specified key from a System.Collections.Generic.IDictionary<> as a IUnDo operation.
  • DoRemoveAt<T>(this IUnDoManager, IList<T>, int, object) Method Removes an item from a System.Collections.Generic.IList<> at the specified index as a IUnDo operation.
• ListUnDo<T> Class Provides an implementation of the IUnDo interface for System.Collections.Generic.IList<> operation.
  • ListUnDo(object, IList<T>, int, T, bool) Constructor Initialises an instance of ListUnDo<T>.
  • ListUnDo(IList<T>, int, T, bool) Constructor Initialises an instance of ListUnDo<T>.
  • DefaultUnDo.IUnDo.Description Explicit Interface Implementation Gets a description of what this IUnDo perform.
  • DefaultUnDo.IUnDo.Do() Explicit Interface Implementation Does an action.
  • DefaultUnDo.IUnDo.Undo() Explicit Interface Implementation Does the opposite of the Do() action.
• UnDo Class Provides an implementation of the IUnDo interface for custom do and undo action.
  • UnDo(object, Action, Action) Constructor Initialises an instance of UnDo.
  • UnDo(Action, Action) Constructor Initialises an instance of UnDo.
  • DefaultUnDo.IUnDo.Description Explicit Interface Implementation Gets a description of what this IUnDo perform.
  • DefaultUnDo.IUnDo.Do() Explicit Interface Implementation Does an action.
  • DefaultUnDo.IUnDo.Undo() Explicit Interface Implementation Does the opposite of the Do() action.
• UnDoField<T> Class Provides a simple wrapper for a field to automatically generate IUnDo operations.
  • UnDoField(IUnDoManager, Func<UnDoFieldChange<T>,object>) Constructor Creates a new instance of UnDoField<T>.
  • UnDoField(IUnDoManager, T, Func<UnDoFieldChange<T>,object>) Constructor Creates a new instance of UnDoField<T>.
  • Value Property Gets or sets the value of the field, generating a IUnDo operation on set.
  • PostSet(T) Method performs a post set treatment, included in the IUnDo operation.
  • PreSet(T) Method Performs a pre set treatment, included in the IUnDo operation.
  • ToT() Method Returns the underlying T.
  • implicit operator T(UnDoField<T>) Operator Defines an implicit conversion of a UnDoField<T> to a T.
• UnDoManager Class Provides an implementation of the command pattern to execute operations and return to a previous state by undoing them.
  • UnDoManager() Constructor Initialises an instance of UnDoManager.
  • UnDoManager(int) Constructor Initialises an instance of UnDoManager.
  • CanRedo Property Returns a boolean to express if the method Redo() can be executed.
  • CanUndo Property Returns a boolean to express if the method Undo() can be executed.
  • RedoDescriptions Property Gets the descriptions in order of all the IUnDo which can be redone.
  • UndoDescriptions Property Gets the descriptions in order of all the IUnDo which can be undone.
  • Version Property Gets an System.Int32 representing the state of the IUnDoManager.
  • BeginTransaction(object) Method Starts a group of operation and return an IUnDoTransaction to stop the group.
    If Commit() is not called, all operations done during the transaction will be undone on System.IDisposable.Dispose.
  • Clear() Method Clears the history of IUnDo operations.
  • Do(IUnDo) Method Executes the IUnDo command and stores it in the manager hostory.
  • Redo() Method Redoes the last undone IUnDo command of the manager history.
  • Undo() Method Undoes the last executed IUnDo command of the manager history.
  • PropertyChanged Event Occurs when a property value changes.
• ValueUnDo Class Provides a global System.TimeSpan to use as default merge interval for all ValueUnDo<T>.
  • MergeDescriptionAction Property The MergeDescriptionHandler(object, object) used to merge description between two ValueUnDo<T> instance.
  • MergeInterval Property The System.TimeSpan interval equivalent ValueUnDo<T> instances should respect to be mergeable.
    Default value is 500ms.
• ValueUnDo<T> Class Provides an implementation of the IUnDo interface for setting value.
  • ValueUnDo(object, Action<T>, T, T) Constructor Initialises an instance of ValueUnDo<T>.
  • ValueUnDo(Action<T>, T, T) Constructor Initialises an instance of ValueUnDo<T>.
  • MergeDescriptionAction Property The MergeDescriptionHandler(object, T, object, T) used to merge description between two ValueUnDo<T> instance.
  • MergeInterval Property The System.TimeSpan interval equivalent ValueUnDo<T> instances should respect to be mergeable.
    If not set, MergeInterval will be used.
  • DefaultUnDo.IMergeableUnDo.TryMerge(IUnDo, IUnDo) Explicit Interface Implementation Merges the current instance with the specified IUnDo.
  • DefaultUnDo.IUnDo.Description Explicit Interface Implementation Gets a description of what this IUnDo perform.
  • DefaultUnDo.IUnDo.Do() Explicit Interface Implementation Does an action.
  • DefaultUnDo.IUnDo.Undo() Explicit Interface Implementation Does the opposite of the Do() action.
• UnDoCollectionOperation Struct Provides data for the operation about to be performed on an undo collection.
  • UnDoCollectionOperation(object, UnDoCollectionAction, object[]) Constructor Initializes a new instance of the UnDoCollectionOperation struct.
  • Action Property Gets the action performed.
  • Collection Property Gets the collection on which the action is performed.
  • Parameters Property Gets the parameters of the action performed.
• UnDoFieldChange<T> Struct Describes a value change operation done on a UnDoField<T>.
  • UnDoFieldChange(T, T) Constructor Initializes a new instance of the UnDoFieldChange<T> struct.
  • NewValue Property Gets the field new value.
  • OldValue Property Gets the field old value.
• IMergeableUnDo Interface Provides a method to try to merge two IUnDo instances into a single one.
  • TryMerge(IUnDo, IUnDo) Method Merges the current instance with the specified IUnDo.
• IUnDo Interface Provides methods to execute an action and remove its effect.
  • Description Property Gets a description of what this IUnDo perform.
  • Do() Method Does an action.
  • Undo() Method Does the opposite of the Do() action.
• IUnDoManager Interface Provides properties and methods of the command pattern to execute operations and return to a previous state by undoing them.
  • CanRedo Property Returns a boolean to express if the method Redo() can be executed.
  • CanUndo Property Returns a boolean to express if the method Undo() can be executed.
  • RedoDescriptions Property Gets the descriptions in order of all the IUnDo which can be redone.
  • UndoDescriptions Property Gets the descriptions in order of all the IUnDo which can be undone.
  • Version Property Gets an System.Int32 representing the state of the IUnDoManager.
  • BeginTransaction(object) Method Starts a group of operation and return an IUnDoTransaction to stop the group.
    If Commit() is not called, all operations done during the transaction will be undone on System.IDisposable.Dispose.
  • Clear() Method Clears the history of IUnDo operations.
  • Do(IUnDo) Method Executes the IUnDo command and stores it in the manager hostory.
  • Redo() Method Redoes the last undone IUnDo command of the manager history.
  • Undo() Method Undoes the last executed IUnDo command of the manager history.
• IUnDoTransaction Interface Represents a transaction to record multiple undo operations as a single operation in the history of a IUnDoManager.
  • Commit() Method Groups all recorded operations in a single GroupUnDo and add it to the history of the IUnDoManager instance this instance was created from.
    If this method is not called before disposing current instance, all recorded operations will be undone.
• UnDoCollectionAction Enum Describes the action that will be performed on an System.Collections.Generic.ICollection<> and recorded by an IUnDoManager.
  • ICollectionAdd Field System.Collections.Generic.ICollection<>.Add(@0) will be performed.
  • ICollectionClear Field System.Collections.Generic.ICollection<>.Clear will be performed.
  • ICollectionRemove Field System.Collections.Generic.ICollection<>.Remove(@0) will be performed.
  • IDictionaryAdd Field System.Collections.Generic.IDictionary<>.Add(@0,@1) will be performed.
  • IDictionaryIndexer Field System.Collections.Generic.IDictionary<>.Item(@@0) will be performed.
  • IDictionaryRemove Field System.Collections.Generic.IDictionary<>.Remove(@0) will be performed.
  • IListIndexer Field System.Collections.Generic.IList<>.Item(System.Int32) will be performed.
  • IListInsert Field System.Collections.Generic.IList<>.Insert(System.Int32,@0) will be performed.
  • IListMove Field Move<T>(this IList<T>, int, int) will be performed.
  • IListRemoveAt Field System.Collections.Generic.IList<>.RemoveAt(System.Int32) will be performed.
  • ISetAdd Field System.Collections.Generic.ISet<>.Add(@0) will be performed.
  • ISetExceptWith Field System.Collections.Generic.ISet<>.ExceptWith(System.Collections.Generic.IEnumerable{@0}) will be performed.
  • ISetIntersectWith Field System.Collections.Generic.ISet<>.IntersectWith(System.Collections.Generic.IEnumerable{@0}) will be performed.
  • ISetSymmetricExceptWith Field System.Collections.Generic.ISet<>.SymmetricExceptWith(System.Collections.Generic.IEnumerable{@0}) will be performed.
  • ISetUnionWith Field System.Collections.Generic.ISet<>.UnionWith(System.Collections.Generic.IEnumerable{@0}) will be performed.
• GroupUnDo.MergeDescriptionHandler(object, object, object) Delegate Represents a method that will be called when merging a GroupUnDo and a IMergeableUnDo instances to get the resulting description.
• ValueUnDo.MergeDescriptionHandler(object, object) Delegate Represents a method that will be called when merging two ValueUnDo<T> instances to get the resulting description.
• ValueUnDo<T>.MergeDescriptionHandler(object, T, object, T) Delegate Represents a method that will be called when merging two ValueUnDo<T> instances to get the resulting description.