MVCANDControllerEditImmutableDocBaseTModel, 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.GuiMVCANControllerEditImmutableDocBaseTModel, TView
      Altaxo.GuiMVCANDControllerEditImmutableDocBaseTModel, TView
        More

Namespace: Altaxo.Gui
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3448.0 (4.8.3448.0)

Syntax

Copy

public abstract class MVCANDControllerEditImmutableDocBase<TModel, TView> : MVCANControllerEditImmutableDocBase<TModel, TView>, 
	IMVCANDController, IMVCANController, IMVCAController, IMVCController, IDisposable, 
	IApplyController, INotifyPropertyChanged
where TView : class

Type Parameters

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

The MVCANDControllerEditImmutableDocBaseTModel, TView type exposes the following members.

Constructors

	Name	Description
	MVCANDControllerEditImmutableDocBaseTModel, TView	Initializes a new instance of the MVCANDControllerEditImmutableDocBaseTModel, TView class
	MVCANDControllerEditImmutableDocBaseTModel, TView(ActionTModel)	Initializes a new instance of the MVCANDControllerEditImmutableDocBaseTModel, TView class

Top

Properties

	Name	Description
	IsDisposed	Gets a value indicating whether this controller is already disposed. (Inherited from ControllerBase)
	ModelObject	Gets the document that this controller has edited. The state of the document changes only after calling Apply(Boolean). (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	NoDocumentException	Gets an exception that is thrown when a controller was not initialized with a document. (Inherited from ControllerBase)
	NotInitializedException	Gets an exception that is thrown when a controller is not properly initialized. (Inherited from ControllerBase)
	NoViewException	Gets an exception that is thrown when a controller currently has no view. (Inherited from ControllerBase)
	ProvisionalModelObject	Gets the provisional model object. This is the model object that is based on the current user input.
	UseDocumentCopy	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 is 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. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	ViewObject	Returns the Gui element that shows the model to the user. (Overrides MVCANControllerEditImmutableDocBaseTModel, TViewViewObject)

Top

Methods

	Name	Description
	Apply	Called when the user input has to be applied to the document being controlled. Returns if applying succeeded. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	ApplyEnd	(Overrides MVCANControllerEditImmutableDocBaseTModel, TViewApplyEnd(Boolean, Boolean))
	AttachView	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 MVCANControllerEditImmutableDocBaseTModel, TView)
	CheckDocumentInitializedT	Checks whether the document has been initialized and throws an exception if it is null. (Inherited from ControllerBase)
	DetachView	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. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ControllerBase)
	Dispose(Boolean)	Releases unmanaged and, optionally, managed resources. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetSubControllers	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). (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Basic initialization of the document. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	InitializeDocument	Initialize the controller with the document. If successfull, the function has to return true. (Overrides MVCANControllerEditImmutableDocBaseTModel, TViewInitializeDocument(Object))
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnMadeDirty	Fires the MadeDirty event (if it is not suppressed).
	OnPropertyChanged	(Inherited from ControllerBase)
	Revert	Tries to revert changes to the model, i.e. restores the original state of the model. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	ThrowIfNotInitialized	Throws an exception if the controller is not initialized with a document. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	MadeDirty	Event fired when the user changed some data that will change the model.
	PropertyChanged	Occurs when a property value changes. (Inherited from ControllerBase)

Top

Fields

	Name	Description
	_doc	The document to edit. If _useDocumentCopy is , this is a copy of the original document; otherwise, it is the original document itself. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	_originalDoc	The original document. If _useDocumentCopy is , it may have been edited by this controller. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	_setModelInParentModel	If not null, this action is invoked during the apply stage to set the model of this controller in the parent object.
	_suppressDirtyEvent	Used to suppress the MadeDirty event of this controller.
	_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. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
	_view	The GUI view of this controller. (Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)

Top

Reference

Altaxo.Gui Namespace

Inheritance Hierarchy