KGy SOFT

ModelBase Class

KGy SOFT Core Libraries Help
Provides a base object for model classes or business objects, which can validate their state, have undo/redo capability and can support committable/revertible editing.
See the Remarks section for details.
Inheritance Hierarchy

SystemObject
  KGySoft.ComponentModelObservableObjectBase
    KGySoft.ComponentModelPersistableObjectBase
      KGySoft.ComponentModelValidatingObjectBase
        KGySoft.ComponentModelModelBase

Namespace:  KGySoft.ComponentModel
Assembly:  KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 5.0.0-rc.1
Syntax

public abstract class ModelBase : ValidatingObjectBase, 
	ICanUndoRedo, ICanUndo, IRevertibleChangeTracking, IChangeTracking, ICanEdit, 
	IEditableObject

The ModelBase type exposes the following members.

Constructors

  NameDescription
Protected methodModelBase
Initializes a new instance of the ModelBase class
Top
Properties

  NameDescription
Public propertyCanRedo
Gets whether there are changes to redo.
Public propertyCanUndo
Gets whether there are changes to undo.
Protected propertyEditableObjectBehavior
Gets how the object should behave if treated as an IEditableObject.
The base implementation returns DisableNesting.
Public propertyEditLevel
Gets the editing level. That is, the number of BeginNewEdit calls without corresponding CommitLastEdit or RevertLastEdit calls.
Public propertyIsModified
Gets whether this instance has been modified. Modified state can be set by the SetModified method.
(Inherited from ObservableObjectBase.)
Public propertyIsValid
Gets whether this instance is valid. That is, if ValidationResults property does not return any entries where the value of Severity is Error.
(Inherited from ValidatingObjectBase.)
Protected propertyUndoCapacity
Gets or sets the undo capacity.
Default value: 20.
Public propertyValidationResults
Gets the validation results for this instance.
(Inherited from ValidatingObjectBase.)
Top
Methods

  NameDescription
Protected methodAffectsModifiedState
Gets whether the change of the specified propertyName affects the IsModified property.
The ModelBase implementation excludes the IsModified, EditLevel, IsValid, UndoCapacity, CanUndo and CanRedo properties.
(Overrides ValidatingObjectBaseAffectsModifiedState(String).)
Public methodBeginNewEdit
Begins a new level of committable/revertible editing session on the object.
Protected methodCanGetProperty
Gets whether the specified property can be get.
The base implementation allows to get the actual instance properties in this instance.
(Inherited from ObservableObjectBase.)
Protected methodCanSetProperty
Gets whether the specified property can be set.
The base implementation allows to set the actual instance properties in this instance if the specified value is compatible with the property type.
(Inherited from ObservableObjectBase.)
Public methodClearUndoHistory
Clears the undo/redo history without performing any undo.
Public methodClone
Creates a new object that is a copy of the current instance.
The base implementation clones the internal property storage, the IsModified property and if clonePropertyChanged is , then also the subscribers of the PropertyChanged event.
(Inherited from ObservableObjectBase.)
Public methodCommitLastEdit
Commits all changes since the last BeginNewEdit call.
Public methodDispose
Releases the resources held by this instance.
(Inherited from ObservableObjectBase.)
Protected methodDispose(Boolean)
Releases the resources held by this instance.
The base implementation removes the subscribers of the PropertyChanged event.
(Inherited from ObservableObjectBase.)
Protected methodDoValidation
Performs the validation on this instance and returns the validation results. Must not return .
(Overrides ValidatingObjectBaseDoValidation.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetT(FuncT, String)
Gets the value of a property, or - if it was not set before -, then creates its initial value. The created initial value will be stored in the internal property storage without triggering the PropertyChanged event. For constant or simple expressions, or to return a default value for a non-existing property without storing it internally use the other Get overload.
For an example, see the Remarks section of the ObservableObjectBase class.
(Inherited from ObservableObjectBase.)
Protected methodGetT(T, String)
Gets the value of a property or defaultValue if no value is stored for it. No new value will be stored if the property does not exist. If the default initial value is too complex and should not be evaluated every time when the property is get, or to throw an exception for an uninitialized property use the other Get overload.
For an example, see the Remarks section of the ObservableObjectBase class.
(Inherited from ObservableObjectBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnPropertyChanged
Raises the PropertyChanged event.
(Overrides ValidatingObjectBaseOnPropertyChanged(PropertyChangedExtendedEventArgs).)
Public methodRedoAll
Redoes all possible redo steps.
Protected methodResetProperty
Resets the property of the specified name, meaning, it will be removed from the underlying storage so the getter methods will return the default value again.
(Inherited from ObservableObjectBase.)
Protected methodResumeChangedEvent
Resumes the raising of the PropertyChanged event suspended by the SuspendChangeEvents method.
(Inherited from ObservableObjectBase.)
Public methodRevertLastEdit
Discards all changes since the last BeginNewEdit call.
Protected methodSet
Sets the value of a property.
For an example, see the Remarks section of the ObservableObjectBase class.
(Inherited from ObservableObjectBase.)
Public methodSetModified
Sets the modified state of this ObservableObjectBase instance represented by the IsModified property.
(Inherited from ObservableObjectBase.)
Protected methodSuspendChangedEvent
Suspends the raising of the PropertyChanged event until ResumeChangeEvents method is called. Supports nested calls.
(Inherited from ObservableObjectBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryCommitAllEdits
Commits all changes of all editing levels.
Public methodTryRedo
Tries to perform one redo step.
Public methodTryRevertAllEdits
Reverts all changes of all editing levels.
Public methodTryUndo
Tries to perform one undo step.
Public methodUndoAll
Undoes all possible undo steps.
Top
Events

  NameDescription
Public eventPropertyChanged
Occurs when a property value changed. The actual type of the event argument is PropertyChangedExtendedEventArgs.
(Inherited from ObservableObjectBase.)
Top
Extension Methods

  NameDescription
Public Extension MethodConvert(Type, CultureInfo)Overloaded.
Converts an Object specified in the obj parameter to the desired targetType.
See the Examples section of the generic ConvertTTarget(Object, CultureInfo) overload for an example.
(Defined by ObjectExtensions.)
Public Extension MethodCode exampleConvertTTarget(CultureInfo)Overloaded.
Converts an Object specified in the obj parameter to the desired TTarget.
(Defined by ObjectExtensions.)
Public Extension MethodIn (Defined by ObjectExtensions.)
Public Extension MethodTryConvert(Type, Object)Overloaded.
Tries to convert an Object specified in the obj parameter to the desired targetType.
(Defined by ObjectExtensions.)
Public Extension MethodTryConvert(Type, CultureInfo, Object)Overloaded.
Tries to convert an Object specified in the obj parameter to the desired targetType.
(Defined by ObjectExtensions.)
Public Extension MethodTryConvertTTarget(TTarget)Overloaded.
Tries to convert an Object specified in the obj parameter to the desired TTarget.
See the Examples section of the ConvertTTarget(Object, CultureInfo) method for a related example.
(Defined by ObjectExtensions.)
Public Extension MethodTryConvertTTarget(CultureInfo, TTarget)Overloaded.
Tries to convert an Object specified in the obj parameter to the desired TTarget.
See the Examples section of the ConvertTTarget(Object, CultureInfo) method for a related example.
(Defined by ObjectExtensions.)
Top
Remarks

Note Note
This class unifies the capabilities of ValidatingObjectBase, EditableObjectBase and UndoableObjectBase classes. If you don't need all of these features you can pick one of these classes as a base class for your business objects. If you need none of these features but only raising events about property changes you can use the ObservableObjectBase or PersistableObjectBase classes. See also the class diagram of the business object base classes of the KGySoft.CoreLibraries assembly:
Class diagram of business object base classes

Differences from ValidatingObjectBase:

Though undo/redo and object editing are independent features, the undo history is cleared when an editing session is reverted by the RevertLastEdit or TryRevertAllEdits methods to avoid confusion.

Note Notes to Implementers

See the Remarks section of the ObservableObjectBase class for an example about how to define properties in a derived class.

See the Remarks section of the ValidatingObjectBase class for an example about how to validate properties in a derived class.

See Also

Reference