Click or drag to resize

MVCANControllerEditCopyOfDocBaseTModel, TView Class

Base class of controllers that edit a copy of the document. This means that the document is not connected to the document tree when edited. If you need the document connected to the document tree during editing, consider using MVCANControllerEditOriginalDocBaseTModel, TView instead.
Inheritance Hierarchy
SystemObject
  Altaxo.GuiControllerBase
    Altaxo.GuiMVCANControllerEditCopyOfDocBaseTModel, TView
      More

Namespace: Altaxo.Gui
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3448.0 (4.8.3448.0)
Syntax
C#
Copy
public abstract class MVCANControllerEditCopyOfDocBase<TModel, TView> : ControllerBase, 
	IMVCANController, IMVCAController, IMVCController, IDisposable, IApplyController
where TModel : class
where TView : class

Type Parameters

TModel
The type of the document to edit.
TView
The type of the view.

The MVCANControllerEditCopyOfDocBaseTModel, TView type exposes the following members.

Constructors
 NameDescription
Protected methodMVCANControllerEditCopyOfDocBaseTModel, TViewInitializes a new instance of the MVCANControllerEditCopyOfDocBaseTModel, TView class
Top
Properties
 NameDescription
Public propertyIsDisposed Gets a value indicating whether this controller is already disposed.
(Inherited from ControllerBase)
Public propertyModelObject Gets the document that this controller has edited. Here the state of the document has changed only after calling Apply(Boolean).
Protected propertyNoDocumentException Gets an exception that is thrown when a controller was not initialized with a document.
(Inherited from ControllerBase)
Protected propertyNotInitializedException Gets an exception that is thrown when a controller is not properly initialized.
(Inherited from ControllerBase)
Protected propertyNoViewException Gets an exception that is thrown when a controller currently has no view.
(Inherited from ControllerBase)
Public propertyUseDocumentCopy Sets whether or not a copy of the document is used. If set to true, a copy of the document is used, so if the controller is not applied, all changes can be reverted. If set to false, no copy must be made. The document is directly changed by the controller, and changes can not be reverted. Use the last option if a controller up in the hierarchy has already made a copy of the document.
Public propertyViewObject Gets or sets the GUI element that shows the model to the user.
Top
Methods
 NameDescription
Public methodApply Called when the user input has to be applied to the document being controlled. Returns if applying succeeded.
Protected methodApplyEnd Helper that performs the final steps of the apply operation, optionally copying back to the original document and disposing the controller.
Protected methodAttachView Override this function to attach the view to the controller, either by subscribing to events of the view, or by setting the controller object on the view.
Protected methodCheckDocumentInitializedT Checks whether the document has been initialized and throws an exception if it is null.
(Inherited from ControllerBase)
Protected methodDetachView Override this function to detach the view from the controller, either by unsubscribing from events of the view or by setting the controller object on the view to null.
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from ControllerBase)
Public methodDispose(Boolean) Releases unmanaged and, optionally, managed resources.
(Overrides ControllerBaseDispose(Boolean))
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetSubControllers Enumerates the sub controllers. This function is called on Dispose(Boolean) of this controller to dispose the sub controllers too. By overriding this function, there is no need to override Dispose(Boolean).
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitialize Basic initialization of the document.
Public methodInitializeDocument Initializes the controller with the document. If successful, the function returns .
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodOnPropertyChanged
(Inherited from ControllerBase)
Public methodRevert Tries to revert changes to the model, i.e. restores the original state of the model.
Protected methodThrowIfNotInitializedThrows an exception if the controller is not initialized with a document.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventPropertyChanged Occurs when a property value changes.
(Inherited from ControllerBase)
Top
Fields
 NameDescription
Protected field_doc The document to edit. If _useDocumentCopy is , this is a copy of the original document; otherwise, it is the original document itself.
Protected field_originalDoc The original document. If _useDocumentCopy is , it may have been edited by this controller.
Protected field_useDocumentCopy If , a copy of the document is made before editing; this copy can later be used to revert the state of the document to the original state.
Protected field_view The GUI view of this controller.
Top
See Also
Inheritance Hierarchy