Back to Devexpress

NonPersistentObjectSpace Members

expressappframework-devexpress-dot-expressapp-dot-nonpersistentobjectspace-dot-underscore-members.md

latest53.7 KB
Original Source

NonPersistentObjectSpace Members

An Object Space used to manage non-persistent objects.

Constructors

NameDescription
NonPersistentObjectSpace(IServiceProvider, ITypesInfo, IEntityStore)Creates a new instance of the NonPersistentObjectSpace class.
NonPersistentObjectSpace(IServiceProvider, ITypesInfo)Creates a new instance of the NonPersistentObjectSpace class.

Fields

NameDescription
AutoCommitAdditionalObjectSpacesByDefault staticSpecifies whether an Object Space’s CommitChanges() method forces additional Object Spaces to commit their changed objects. When this property is set to true , changes to objects that belong to additional Object Spaces mark the Object Space as modified. This field affects all Object Spaces in your application if you do not specify the AutoCommitAdditionalObjectSpaces property for a particular Object Space. Inherited from CompositeObjectSpace.
AutoDisposeAdditionalObjectSpacesByDefault staticSpecifies whether Object Spaces dispose of their inner Object Spaces from the AdditionalObjectSpaces collection when they dispose of themselves. This field affects all Object Spaces in your application if you do not specify the AutoDisposeAdditionalObjectSpaces property for a particular Object Space. Inherited from CompositeObjectSpace.
AutoRefreshAdditionalObjectSpacesByDefault staticSpecifies whether Object Spaces refresh their inner Object Spaces from the AdditionalObjectSpaces collection when refreshing themselves. This field affects all Object Spaces in your application if you do not specify the AutoRefreshAdditionalObjectSpaces property for a particular Object Space. Inherited from CompositeObjectSpace.
AutoSetModifiedOnObjectChangeByDefault staticSpecifies whether non-persistent Object Spaces add objects to the ModifiedObjects collection when these objects raise the PropertyChanged event. This field affects all non-persistent Object Spaces in your application if you do not specify the AutoSetModifiedOnObjectChange property for a particular Object Space.
CompositeKeyPropertyType staticFor internal use. Inherited from BaseObjectSpace.
ThrowExceptionForNotRegisteredEntityType staticCertain Object Space methods have the Type parameters. This static field indicates whether these methods throw the ArgumentException when a passed type is not registered in the Object Space Provider’s entity store. Set this field to true to diagnose issues related to the incorrect use of the Object Space type (for example, when a persistent Object Space is used to manipulate non-persistent objects). Inherited from BaseObjectSpace.

Properties

NameDescription
AdditionalObjectSpacesGets the list of Object Spaces used to handle objects that do not belong to the current Object Space. We recommend that you call the PopulateAdditionalObjectSpaces(XafApplication) method to populate this collection automatically. Inherited from CompositeObjectSpace.
AutoCommitAdditionalObjectSpacesSpecifies whether the current Object Space’s CommitChanges() method forces additional Object Spaces to commit their changed objects. When this property is set to true , changes to objects that belong to additional Object Spaces mark the Object Space as modified. Inherited from CompositeObjectSpace.
AutoDisposeAdditionalObjectSpacesSpecifies whether the current Object Space disposes of its inner Object Spaces from the AdditionalObjectSpaces collection when it disposes itself. Inherited from CompositeObjectSpace.
AutoRefreshAdditionalObjectSpacesSpecifies whether the current Object Space refreshes its inner Object Spaces from the AdditionalObjectSpaces collection when it refreshes itself. Inherited from CompositeObjectSpace.
AutoSetModifiedOnObjectChangeSpecifies whether the current non-persistent Object Space adds objects to the ModifiedObjects collection when they raise the PropertyChanged event.
ConnectionGets the connection to the underlying data source. Inherited from BaseObjectSpace.
DatabaseGets the name of the database. Inherited from BaseObjectSpace.
IsCommittingIndicates whether the Object Space is currently committing the changes made to its object(s). Inherited from BaseObjectSpace.
IsConnectedIndicates whether the BaseObjectSpace is connected to the database. Inherited from BaseObjectSpace.
IsDeletingIndicates whether the current Object Space is about to delete an object(s). Inherited from BaseObjectSpace.
IsDisposedGets a value indicating whether an Object Space has been disposed of. Inherited from BaseObjectSpace.
IsModifiedSpecifies whether objects belonging to the current Object Space are modified. Inherited from BaseObjectSpace.
IsReloadingGets a boolean value indicating whether or not the Object Space is reloading. Inherited from BaseObjectSpace.
LockingCheckEnabledSpecifies whether or not the additional locking check is performed. Inherited from BaseObjectSpace.
ModifiedObjectsGets a list of non-persistent objects modified within the current NonPersistentObjectSpace.
NonPersistentChangesEnabledSpecifies whether the BaseObjectSpace is marked as modified (see BaseObjectSpace.IsModified) when a non-persistent property is changed. Inherited from BaseObjectSpace.
OwnerSpecifies the current Object Space’s root View or the root Object Space if the current Object Space is added to the AdditionalObjectSpaces collection. Inherited from BaseObjectSpace.
ServiceProviderGets the IServiceProvider used to access the application’s services.
TypesInfoGets information on the business classes added to the Application Model (see IModelBOModel). Inherited from BaseObjectSpace.

Methods

NameDescription
ApplyCriteria(Object, CriteriaOperator)Filters the specified collection according to the specified criteria on the server side. Inherited from CompositeObjectSpace.
ApplyFilter(Object, CriteriaOperator)Filters the specified collection according to the specified criteria on the client side. Inherited from CompositeObjectSpace.
CanApplyCriteria(Type)Indicates whether collections of a specified type can be filtered on the server side. Inherited from CompositeObjectSpace.
CanApplyFilter(Object)Indicates whether collections of a specified type can be filtered on the client side. Inherited from CompositeObjectSpace.
CanInstantiate(Type)Indicates whether instances of a particular type can be created. Inherited from CompositeObjectSpace.
CommitChanges()Saves all the changes made to the persistent objects belonging to the current Object Space to the database. Inherited from BaseObjectSpace.
Contains(Object)Indicates whether a specified object belongs to the current Object Space.
ConvertExpressionsStringToExpressionsList(String) staticReturns the list of DataViewExpression objects converted from the passed semicolon-separated expressions list. Inherited from BaseObjectSpace.
ConvertSortingToString(IList<SortProperty>) staticReturns the string representation of a given sort list. Inherited from BaseObjectSpace.
ConvertStringToSorting(String) staticConverts the sorting string into the sorting list. Inherited from BaseObjectSpace.
CreateCollection(Type, CriteriaOperator, IList<SortProperty>)Creates and initializes a collection of objects of the specified type, filtered according to the specified criteria and sorted according to the given sorting list. Inherited from BaseObjectSpace.
CreateCollection(Type, CriteriaOperator)Creates and initializes a collection of objects of the specified type, filtered according to the specified criteria. Inherited from BaseObjectSpace.
CreateCollection(Type)Creates and initializes a collection of objects of the specified type. Inherited from BaseObjectSpace.
CreateDataView(Type, IList<DataViewExpression>, CriteriaOperator, IList<SortProperty>)Returns a list of data records retrieved from the database without loading complete business classes (a data view). Inherited from BaseObjectSpace.
CreateDataView(Type, String, CriteriaOperator, IList<SortProperty>)Returns a list of data records retrieved from a database without loading complete business classes (a data view). Values in each data record can be obtained from specific business class properties directly, or be evaluated by the database server using complex expressions. Inherited from BaseObjectSpace.
CreateInstantFeedbackCollection(Type, CriteriaOperator)Creates an InstantFeedback mode collection that contains the specified type objects filtered according to the criteria. Inherited from CompositeObjectSpace.
CreateNestedObjectSpace()Creates a nested Object Space.
CreateObject(Type)Creates an object of the specified type.
CreateObject<ObjectType>()Creates an object of the type designated by the specified generic type parameter. Inherited from BaseObjectSpace.
CreateParseCriteriaScope()
CreateServerCollection(Type, CriteriaOperator)Creates and initializes a new instance of the EFServerCollection or XPServerCollectionSource class with criteria-specific options. Inherited from CompositeObjectSpace.
Delete(IList)Marks the specified persistent objects and their aggregated objects as deleted from the database. Inherited from BaseObjectSpace.
Delete(Object)Marks the specified persistent object and its aggregated objects as deleted from persistent storage. Inherited from BaseObjectSpace.
Dispose()Releases all resources used by an NonPersistentObjectSpace object.
EnableObjectDeletionOnRemove(Object, Boolean)Enables/disables the deletion of persistent objects from the data source when they are removed from the specified collection. Inherited from BaseObjectSpace.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
Evaluate(Type, CriteriaOperator, CriteriaOperator)Evaluates the specified criteria for business objects of the given type. Inherited from BaseObjectSpace.
FindObject(Type, CriteriaOperator, Boolean)Searches for the first object that matches the specified criteria and of the specified type. This method takes uncommitted changes into account.
FindObject(Type, CriteriaOperator)Searches for the first object of the specified type, matching the specified criteria. Inherited from BaseObjectSpace.
FindObject<ObjectType>(CriteriaOperator, Boolean)Searches for the first object of the type designated by the specified generic type parameter, matching the specified criteria. Inherited from BaseObjectSpace.
FindObject<ObjectType>(CriteriaOperator)Searches for the first object of the type designated by the specified generic type parameter, matching the specified criteria. Inherited from BaseObjectSpace.
FindObjectSpaceByObject(Object) staticReturns the Object Space used to load and save a specified persistent object. This method is for internal use. Inherited from BaseObjectSpace.
FirstOrDefault<ObjectType>(Expression<Func<ObjectType, Boolean>>, Boolean)Searches for the first object that matches the specified criteria.
FirstOrDefault<ObjectType>(Expression<Func<ObjectType, Boolean>>)Searches for the first object that matches the specified lambda expression. The generic parameter determines the object’s type. Inherited from BaseObjectSpace.
GetAssociatedCollectionCriteria(Object, IMemberInfo)Returns the criteria applied to a specific object’s associated collection property. Inherited from BaseObjectSpace.
GetCollectionObjectType(Object)Inherited from CompositeObjectSpace.
GetCollectionSorting(Object)Returns the sort settings for a collection. Inherited from CompositeObjectSpace.
GetCriteria(Object)Returns the criteria used to filter a specified collection on the server side. Inherited from CompositeObjectSpace.
GetDisplayableProperties(Object)Gets the properties considered visible by the specified collection. Inherited from BaseObjectSpace.
GetEvaluatorContextDescriptor(Type)For internal use.
GetExpressionEvaluator(EvaluatorContextDescriptor, CriteriaOperator)Creates an ExpressionEvaluator object that is used to evaluate whether objects of the specified type satisfy a particular criteria. Inherited from BaseObjectSpace.
GetExpressionEvaluator(Type, CriteriaOperator)Creates an ExpressionEvaluator object that is used to evaluate whether objects of the specified type satisfy a particular criteria. Inherited from BaseObjectSpace.
GetFilter(Object)Returns the criteria used to filter a particular collection on the client side. Inherited from BaseObjectSpace.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetKeyPropertyName(Type)Gets the name of the specified type’s key property. Inherited from BaseObjectSpace.
GetKeyPropertyType(Type)Gets the key property type of the specified business type. Inherited from BaseObjectSpace.
GetKeyValue(ITypesInfo, Object) staticReturns the key property’s value of the specified persistent object. Inherited from BaseObjectSpace.
GetKeyValue(Object)Returns the key property’s value of the specified object. Inherited from CompositeObjectSpace.
GetKeyValueAsString(ITypesInfo, Object) staticInherited from BaseObjectSpace.
GetKeyValueAsString(Object)Returns the key property’s value of the specified object, converted to a string representation. Inherited from BaseObjectSpace.
GetObject(Object)Retrieves an object from another Object Space to the current Object Space.
GetObject<ObjectType>(ObjectType)Retrieves an object from another Object Space to the current Object Space. The returned object is cast by the type designated by the specified generic type parameter. Inherited from BaseObjectSpace.
GetObjectByHandle(String)Returns the object with the specified handle. Inherited from BaseObjectSpace.
GetObjectByKey(Type, Object)
GetObjectByKey<ObjectType>(Object)Returns a persistent object of the type designated by the specified generic type parameter, with the specified value for its key property. Inherited from BaseObjectSpace.
GetObjectHandle(Object)Returns an object’s handle. Inherited from BaseObjectSpace.
GetObjectKey(Type, String)Converts the key property value string representation into its actual type. Inherited from CompositeObjectSpace.
GetObjects(Type, CriteriaOperator, Boolean)Returns an IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria. Inherited from BaseObjectSpace.
GetObjects(Type, CriteriaOperator, IList<SortProperty>, Boolean)Returns a sorted IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria. Inherited from BaseObjectSpace.
GetObjects(Type, CriteriaOperator)Returns an IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria. Inherited from BaseObjectSpace.
GetObjects(Type)Returns an IList collection of objects of the specified type, retrieved to the current Object Space. Inherited from BaseObjectSpace.
GetObjects<T>()Returns an IList collection of objects of the specified type, retrieved to the current Object Space. Inherited from BaseObjectSpace.
GetObjects<T>(CriteriaOperator, Boolean)Returns an IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria. Inherited from BaseObjectSpace.
GetObjects<T>(CriteriaOperator, IList<SortProperty>, Boolean)Returns a sorted IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria. Inherited from BaseObjectSpace.
GetObjects<T>(CriteriaOperator)Returns an IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria. Inherited from BaseObjectSpace.
GetObjectsCount(Type, CriteriaOperator)Returns the number of objects specified.
GetObjectsCriteria(ITypeInfo, IList)Constructs a criteria that can be used to select the specified list of business objects. Inherited from BaseObjectSpace.
GetObjectsQuery<T>(Boolean)Gets a queryable data structure that provides functionality to evaluate queries against a specific business object type.
GetObjectsToDelete(Boolean)
GetObjectsToSave(Boolean)
GetObjectType(Object)Returns the type of the specified business object. Inherited from BaseObjectSpace.
GetTopReturnedObjectsCount(Object)Returns the maximum number of objects that the specified collection can retrieve from a data store. Inherited from CompositeObjectSpace.
GetType()Gets the Type of the current instance. Inherited from Object.
IsCollectionLoaded(Object)For internal use. Inherited from CompositeObjectSpace.
IsDeletedObject(Object)Indicates whether the specified persistent object is deleted and committed.
IsDeletionDeferredType(Type)Returns a value that indicates if the deferred deletion is enabled for persistent objects of a given type. Inherited from BaseObjectSpace.
IsDisposedObject(Object)Determines whether an object has been disposed of. Inherited from BaseObjectSpace.
IsKnownType(Type, Boolean)Checks whether the Object Space (or any Object Space from its AdditionalObjectSpaces collection) can handle objects of the specified type. Inherited from CompositeObjectSpace.
IsKnownType(Type)Returns the boolean value indicating whether or not the specified type is known by the BaseObjectSpace. Inherited from BaseObjectSpace.
IsNewObject(Object)Indicates whether a specified object has been created but has not been saved to the database.
IsObjectDeletionOnRemoveEnabled(Object)Indicates whether the deletion of persistent objects from the data source when they are removed from the specified collection is enabled. Inherited from BaseObjectSpace.
IsObjectFitForCriteria(Object, CriteriaOperator)Specifies whether the specified object satisfies the specified criteria. Inherited from BaseObjectSpace.
IsObjectFitForCriteria(Type, Object, CriteriaOperator)Specifies whether a particular object satisfies the specified criteria. Inherited from BaseObjectSpace.
IsObjectToDelete(Object)
IsObjectToSave(Object)
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ObjectKeyValuesEqual(ITypeInfo, Object, Object) staticInherited from BaseObjectSpace.
ParseCriteria(String)Tries to convert the specified string representation of an expression to its CriteriaOperator equivalent. Inherited from BaseObjectSpace.
PopulateAdditionalObjectSpaces(IObjectSpaceProviderService, IObjectSpaceCustomizerService)Creates Object Spaces for registered Object Space Providers and adds them to the AdditionalObjectSpaces collection. Object Spaces in this collection are automatically disposed of with the owner Object Space. Inherited from CompositeObjectSpace.
PopulateAdditionalObjectSpaces(XafApplication)Creates Object Spaces for registered Object Space Providers and adds them to the AdditionalObjectSpaces collection. Object Spaces in this collection are automatically disposed of with the owner Object Space. Inherited from CompositeObjectSpace.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Refresh()Invalidates all previously loaded objects in the current Object Space and resets any unsaved changes made by users. Inherited from BaseObjectSpace.
ReloadCollection(Object)Clears the specified collection. Inherited from CompositeObjectSpace.
ReloadObject(Object)
RemoveFromModifiedObjects(Object)Removes the specified object from the list of objects to be committed.
Rollback(Boolean)Discards all unsaved changes made by users and invalidates previously loaded objects in the current Object Space. Inherited from BaseObjectSpace.
SetCollectionSorting(Object, IList<SortProperty>)Applies the specified sort settings to the collection. Inherited from CompositeObjectSpace.
SetDisplayableProperties(Object, String)Changes the properties considered visible by a particular collection. Inherited from BaseObjectSpace.
SetModified(Object, IMemberInfo)Sets the state of the specified object to be Modified. Inherited from BaseObjectSpace.
SetModified(Object)Sets the state of the specified object to be Modified. Inherited from BaseObjectSpace.
SetPrefetchPropertyNames(Object, String[])Loads specified delayed properties and child collections in each object of a given list. Inherited from BaseObjectSpace.
SetTopReturnedObjectsCount(Object, Int32)Sets the maximum number of objects that the specified collection can retrieve from a data store. Inherited from CompositeObjectSpace.
ToString()Returns a string that represents the current object. Inherited from Object.

Events

NameDescription
CommittedRaised after saving changes made to persistent objects belonging to the current Object Space to the database. Inherited from BaseObjectSpace.
CommittingOccurs before saving the persistent objects belonging to the current Object Space to the database. Inherited from BaseObjectSpace.
ConfirmationRequiredOccurs when performing Refresh or Rollback operations with the current Object Space’s persistent objects. Inherited from BaseObjectSpace.
ConnectedOccurs after a connection to a database has been established. Inherited from BaseObjectSpace.
CustomCommitChangesReplaces the default process for committing changes made to persistent objects with a custom one. Inherited from BaseObjectSpace.
CustomDeleteObjectsOccurs to replace the default process of deleting persistent objects with a custom one. Inherited from BaseObjectSpace.
CustomGetObjectsQueryOccurs when the GetObjectsQuery<T>(Boolean) method is executed.
CustomRefreshOccurs to replace the default process of refreshing persistent objects with a custom one. Inherited from BaseObjectSpace.
CustomRollBackOccurs to replace the default process of persistent objects rollback with a custom one. Inherited from BaseObjectSpace.
DisposedOccurs before an Object Space is disposed of. Inherited from BaseObjectSpace.
ModifiedChangedOccurs when the current Object Space’s BaseObjectSpace.IsModified state is changed. Inherited from BaseObjectSpace.
ModifiedChangingOccurs before the IsModified property is changed to true. Handle this event to cancel the property change or force the IsModified property to change. Inherited from BaseObjectSpace.
ObjectByKeyGettingOccurs when an object is retrieved by its key, using the NonPersistentObjectSpace.GetObjectByKey method.
ObjectChangedRaised when a persistent object is created, changed or deleted. Inherited from BaseObjectSpace.
ObjectDeletedOccurs after the specified objects have been deleted. Inherited from BaseObjectSpace.
ObjectDeletingOccurs when the specified objects are about to be deleted. Inherited from BaseObjectSpace.
ObjectEndEditOccurs after ending an edit operation taking place on the specified object. Inherited from BaseObjectSpace.
ObjectGettingOccurs when NonPersistentObjectSpace gets an object using the NonPersistentObjectSpace.GetObject method .
ObjectReloadedOccurs after an object has been reloaded from the database. Inherited from BaseObjectSpace.
ObjectReloadingOccurs before an object is reloaded. Handle this event to reload the object state from storage and cancel changes.
ObjectSavedOccurs after saving changes made to a specified persistent object to the database. Inherited from BaseObjectSpace.
ObjectSavingRaised before saving changes made to a specified persistent object to the database. Inherited from BaseObjectSpace.
ObjectsCountGettingOccurs when the NonPersistentObjectSpace.GetObjectsCount method is called.
ObjectsGettingOccurs when NonPersistentObjectSpace creates a collection of non-persistent objects.
RefreshingOccurs before refreshing the current Object Space’s persistent objects. Inherited from BaseObjectSpace.
ReloadedOccurs when the BaseObjectSpace.Rollback or BaseObjectSpace.Refresh method is called. Inherited from BaseObjectSpace.
RollingBackOccurs before rolling back the changes made to the current Object Space’s persistent objects. Inherited from BaseObjectSpace.

See Also

NonPersistentObjectSpace Class

DevExpress.ExpressApp Namespace