Click or drag to resize

MVCANDControllerEditCopyOfDocBaseTModel, 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. This class indicates changes made to the document by firing the MadeDirty event.
Inheritance Hierarchy
SystemObject
  Altaxo.GuiControllerBase
    Altaxo.GuiMVCANControllerEditCopyOfDocBaseTModel, TView
      Altaxo.GuiMVCANDControllerEditCopyOfDocBaseTModel, TView
        Altaxo.Gui.MainInstancePropertyController

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

Type Parameters

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

The MVCANDControllerEditCopyOfDocBaseTModel, TView type exposes the following members.

Constructors
 NameDescription
Protected methodMVCANDControllerEditCopyOfDocBaseTModel, TViewInitializes a new instance of the MVCANDControllerEditCopyOfDocBaseTModel, TView class
Top
Properties
 NameDescription
Public propertyIsDisposedGet a value indication whether this controller is already disposed.
(Inherited from ControllerBase)
Public propertyModelObject Returns the document that this controller has edited. Here the state of the document has changed only after calling Apply(Boolean).
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Protected propertyNoDocumentException
(Inherited from ControllerBase)
Protected propertyNotInitializedException
(Inherited from ControllerBase)
Protected propertyNoViewException
(Inherited from ControllerBase)
Public propertyProvisionalModelObject Gets the provisional model object. This is the model object that is based on the current user input.
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 hierarchie has already made a copy of the document.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Public propertyViewObject Returns the Gui element that shows the model to the user.
(Overrides MVCANControllerEditCopyOfDocBaseTModel, TViewViewObject)
Top
Methods
 NameDescription
Public methodApply Called when the user input has to be applied to the document being controlled. Returns true if Apply is successfull.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Protected methodApplyEnd
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
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.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Protected methodCheckDocumentInitializedT
(Inherited from ControllerBase)
Protected methodDetachView Override this function to detach the view from the controller, either by unsubscribing to events of the view, or by setting the controller object on the view to null.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Public methodDispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from ControllerBase)
Public methodDispose(Boolean) Releases unmanaged and - optionally - managed resources.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
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 subcontrollers too. By overriding this function, there is no need to override Dispose(Boolean)
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitialize Basic initialization of the document.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Public methodInitializeDocument Initialize the controller with the document. If successfull, the function has to return true.
(Overrides MVCANControllerEditCopyOfDocBaseTModel, TViewInitializeDocument(Object))
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnMadeDirty Fires the MadeDirty event (if it is not suppressed).
Public methodOnPropertyChanged
(Inherited from ControllerBase)
Public methodRevert Try to revert changes to the model, i.e. restores the original state of the model.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Protected methodThrowIfNotInitializedThrows an exception if the controller is not initialized with a document.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventMadeDirty Event fired when the user changed some data that will change the model.
Public eventPropertyChanged Occurs when a property value changes.
(Inherited from ControllerBase)
Top
Fields
 NameDescription
Protected field_docThe document to edit. If _useDocumentCopy is true, this is a copy of the original document; otherwise, it is the original document itself.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Protected field_originalDocThe original document. If _useDocumentCopy is false, it maybe has been edited by this controller.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Protected field_suppressDirtyEvent Used to suppress the MadeDirty event of this controller.
Protected field_useDocumentCopyIf true, 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.
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Protected field_viewThe Gui view of this controller
(Inherited from MVCANControllerEditCopyOfDocBaseTModel, TView)
Top
See Also