Click or drag to resize

ConditionalDocumentControllerTModel Class

Wraps a controller that can be enabled or disabled together with its model.
Inheritance Hierarchy
SystemObject
  Altaxo.Gui.CommonConditionalDocumentControllerTModel

Namespace: Altaxo.Gui.Common
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
Copy
public class ConditionalDocumentController<TModel> : IConditionalDocumentController, 
	INotifyPropertyChanged, IMVCANController, IMVCAController, IMVCController, IDisposable, 
	IApplyController

Type Parameters

TModel
The type of the wrapped model.

The ConditionalDocumentControllerTModel type exposes the following members.

Constructors
 NameDescription
Public methodConditionalDocumentControllerTModel(FuncTModel, Action) Initializes a new instance of the ConditionalDocumentControllerTModel class.
Public methodConditionalDocumentControllerTModel(FuncTModel, Action, FuncTModel, UseDocument, IMVCANController) Initializes a new instance of the ConditionalDocumentControllerTModel class.
Top
Properties
 NameDescription
Public propertyEnablingText Gets the text used to enable the conditional view.
Public propertyIsConditionalViewEnabled Gets a value indicating whether the conditional view is enabled.
Public propertyModelObject Gets the model (document) that this controller manages.
Public propertyModelObjectOrNull Gets the model object or if the conditional view is disabled.
Public propertyUnderlyingController Gets or sets the underlying controller.
Public propertyUnderlyingView Gets the underlying view object, if enabled.
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 cannot be reverted. Use the last option if a controller higher 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 apply is successful.
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
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 methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInitializeDocument Initializes the controller with the document.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnEnabledChanged Updates the controller state after the enabled flag has changed.
Protected methodOnPropertyChanged Raises the PropertyChanged event.
Public methodRevert Try to revert changes to the model, i.e. restores the original state of the model.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventPropertyChangedOccurs when a property value changes.
Top
See Also