MVCANControllerEditImmutableDocBaseTModel, TView Class

Base class of controllers that edit an immutable document or a document that is a struct. This means that the document can be copied from one member to another without cloning it.

Inheritance Hierarchy

SystemObject
  Altaxo.GuiControllerBase
    Altaxo.GuiMVCANControllerEditImmutableDocBaseTModel, TView
      More

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

Syntax

Copy

public abstract class MVCANControllerEditImmutableDocBase<TModel, TView> : ControllerBase, 
	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 MVCANControllerEditImmutableDocBaseTModel, TView type exposes the following members.

Constructors

	Name	Description
	MVCANControllerEditImmutableDocBaseTModel, TView	Initializes a new instance of the MVCANControllerEditImmutableDocBaseTModel, 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).
	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)
	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.
	ViewObject	Gets or sets the GUI element that shows the model to the user.

Top

Methods

	Name	Description
	Apply	Called when the user input has to be applied to the document being controlled. Returns if applying succeeded.
	ApplyEnd	Helper that performs the final steps of the apply operation, optionally disposing the controller.
	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.
	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.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ControllerBase)
	Dispose(Boolean)	Releases unmanaged and, optionally, managed resources. (Overrides ControllerBaseDispose(Boolean))
	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).
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Basic initialization of the document.
	InitializeDocument	Initializes the controller with the document. If successful, the function returns .
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnPropertyChanged	(Inherited from ControllerBase)
	Revert	Tries to revert changes to the model, i.e. restores the original state of the model.
	ThrowIfNotInitialized	Throws an exception if the controller is not initialized with a document.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	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.
	_originalDoc	The original document. If _useDocumentCopy is , it may have been edited by 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.
	_view	The GUI view of this controller.

Top

Reference

Altaxo.Gui Namespace

Inheritance Hierarchy