.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

XPObjectSpace Members

An Object Space which is used for data manipulation via the DevExpress ORM Tool (XPO).

Properties

Name Description
AsyncServerModeSourceDismissSession Obsolete. This property is obsolete (use the 'InstantFeedbackSourceDismissSession' field instead).
AsyncServerModeSourceResolveSession Obsolete. This property is obsolete (use the 'InstantFeedbackSourceResolveSession' field instead).
CanFilterByNonPersistentMembers For internal use.
(Inherited from BaseObjectSpace)
Connection Gets the connection to the underlying data source.
Database Gets the name of the database used when a connection associated with the current Object Space's XPObjectSpace.Session is opened.
InstantFeedbackMappingMode Specifies what properties should be mapped on a grid in the InstantFeedback mode.
IsAsyncOperationInProgress Specifies whether an asynchronous operation is in progress.
IsCommitting Indicates whether the Object Space is currently committing the changes made to its object(s).
(Inherited from BaseObjectSpace)
IsConnected Indicates whether the XPObjectSpace's Session is connected to the database.
IsDeleting Indicates whether the current Object Space is about to delete an object(s).
(Inherited from BaseObjectSpace)
IsDisposed Gets a value indicating whether an Object Space has been disposed of.
(Inherited from BaseObjectSpace)
IsModified Specifies whether objects belonging to the current Object Space are modified.
(Inherited from BaseObjectSpace)
IsReloading Gets a boolean value indicating whether or not the Object Space is reloading.
(Inherited from BaseObjectSpace)
LockingCheckEnabled Specifies whether or not the additional locking check is performed.
(Inherited from BaseObjectSpace)
ModifiedObjects Returns a collection of objects that have been created, modified or deleted after they were retrieved or committed.
NonPersistentChangesEnabled Specifies whether the BaseObjectSpace is marked as modified (see BaseObjectSpace.IsModified) when a non-persistent property is changed.
(Inherited from BaseObjectSpace)
Owner Specifies the View owning the current Object Space.
(Inherited from BaseObjectSpace)
Session Provides access to a Session that is used to load and save persistent objects.
TypesInfo Gets information on the business classes added to the Application Model (see IModelBOModel).
(Inherited from BaseObjectSpace)
XpoTypeInfoSource

Methods

Name Description
ApplyCriteria(Object, CriteriaOperator) Filters a particular collection on the server side.
ApplyFilter(Object, CriteriaOperator) Filters a particular collection on the client side.
CanApplyCriteria(Type) Indicates whether collections of a particular type can be filtered on the server side.
CanApplyFilter(Object) Indicates whether a particular collection can be filtered on the client side.
CanInstantiate(Type) Indicates whether instances of a particular type can be created.
CombineCriteria(CriteriaOperator[]) static Combines criteria operators passed as parameters.
CommitChanges() Saves all the changes made to the persistent objects belonging to the current Object Space to the database.
(Inherited from BaseObjectSpace)
CommitChangesAsync(CancellationToken) Asynchronously saves all the changes made to the persistent objects belonging to the current Object Space to the database.
Contains(Object) Indicates whether a specified object belongs to the current Object Space.
ConvertExpressionsStringToExpressionsList(String) static Returns the list of DataViewExpression objects converted from the passed semicolon-separated expressions list.
(Inherited from BaseObjectSpace)
ConvertSortingToString(IList<SortProperty>) static Returns the string representation of a given sort list.
(Inherited from BaseObjectSpace)
ConvertStringToSorting(String) static Converts the sorting string into the sorting list.
(Inherited from BaseObjectSpace)
CreateCollection(Type) Creates and initializes a collection of objects of the specified type.
(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, 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)
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)
CreateInstantFeedbackView(Type, CriteriaOperator)
CreateInstantFeedbackView(Type, ServerViewProperty[], CriteriaOperator)
CreateNestedObjectSpace() Creates a nested Object Space.
CreateObject(Type) Creates an object of the specified type.
(Inherited from BaseObjectSpace)
CreateObject<ObjectType>() Creates an object of the type designated by the specified generic type parameter.
(Inherited from BaseObjectSpace)
CreateParseCriteriaScope() Used when parsing a CriteriaOperator represented by a string and containing persistent objects.
CreateServerCollection(Type, CriteriaOperator) Creates and initializes a new instance of the XPServerCollectionSource class with the current Object Space's XPObjectSpace.Session and criteria-specific options.
CreateServerModeView(Type, ServerViewProperty[], CriteriaOperator)
CreateServerView(Type, CriteriaOperator)
CreateSortingCollection(IList<SortProperty>) static
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 XPObjectSpace object.
EnableObjectDeletionOnRemove(Object, Boolean) Enables/disables the deletion of persistent objects from the data source when they are removed from the specified collection.
Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) static Determines whether the specified object instances are considered equal.
(Inherited from Object)
Evaluate(Type, CriteriaOperator, CriteriaOperator) Evaluates the specified criteria for business objects of the given type.
EvaluateAsync(Type, CriteriaOperator, CriteriaOperator, CancellationToken) Asynchronously evaluates the specified criteria for business objects of the given type.
FindObject(Type, CriteriaOperator) Searches for the first object of the specified type, matching the specified criteria.
(Inherited from BaseObjectSpace)
FindObject(Type, CriteriaOperator, Boolean) Searches for the first object which matches the specified criteria.
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)
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)
FindObjectAsync(Type, CriteriaOperator, Boolean, CancellationToken) Asynchronously searches for an object that matches the specified criteria.
FindObjectAsync<ObjectType>(CriteriaOperator, Boolean, CancellationToken) Asynchronously searches for an object that matches the specified criteria. The specified generic parameter determines the object's type.
FindObjectAsync<ObjectType>(CriteriaOperator, CancellationToken) Asynchronously searches for an object that matches the specified criteria. This object's type is designated by the specified generic parameter.
FindObjectSpaceByObject(Object) static Determines the Object Space used to load and save a specified persistent object.
GetAssociatedCollectionCriteria(Object, IMemberInfo) Returns the criteria applied to a specific object's associated collection property.
(Inherited from BaseObjectSpace)
GetCollectionObjectType(Object)
GetCollectionSorting(Object) Returns the sort settings for a particular collection.
GetCriteria(Object) Returns the criteria used to filter a particular collection on the server side.
GetDisplayableProperties(Object) Gets the properties considered visible by the specified collection.
GetEvaluatorContextDescriptor(Type) Creates an instance of the EvaluatorContextDescriptor that is used to supply metadata on the specified type to the ExpressionEvaluator objects.
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.
GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetIntermediateObjectReferences(Object, out Object, out 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) static Returns the key property's value of the specified persistent object.
(Inherited from BaseObjectSpace)
GetKeyValue(Object) Returns the key property's value of the specified persistent object.
GetKeyValueAsString(ITypesInfo, Object) static
(Inherited from BaseObjectSpace)
GetKeyValueAsString(Object) Returns the key property's value of the specified object, converted to a string representation.
GetListServer(Object) For internal use.
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)
GetObjectAsync(Object, CancellationToken) Asynchronously retrieves an object that corresponds to an IObjectRecord wrapper or object from another Object Space.
GetObjectByHandle(String) Returns the object with the specified handle.
(Inherited from BaseObjectSpace)
GetObjectByKey(Type, Object) Returns the persistent object that has the specified value for its key property.
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)
GetObjectByKeyAsync(Type, Object, CancellationToken) Returns the persistent object that has the specified value for its key property.
GetObjectByKeyAsync<ObjectType>(Object, CancellationToken) Returns the persistent object that has the specified value for its key property.
GetObjectHandle(Object) Returns an object's handle.
(Inherited from BaseObjectSpace)
GetObjectKey(Type, String) Converts the key property value string representation into its actual type.
GetObjects(Type) Returns an IList collection of objects of the specified type, retrieved to the current Object Space.
(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, 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<T>() Returns an IList collection of objects of the specified type, retrieved to the current Object Space.
(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)
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)
GetObjectsCount(Type, CriteriaOperator) Returns the number of objects specified.
(Inherited from BaseObjectSpace)
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) Returns a collection of persistent objects that will be deleted when the current transaction is committed, including objects that will be deleted in the parent transaction(s), optionally.
GetObjectsToSave(Boolean) Returns a collection of persistent objects that will be saved when the current transaction is committed, including objects that will be saved in the parent transaction(s), optionally.
GetObjectType(Object) Returns the type of the specified business object.
(Inherited from BaseObjectSpace)
GetTopReturnedObjectsCount(Object) Returns the maximum number of objects to be retrieved by the specified collection from a data store.
GetType() Gets the Type of the current instance.
(Inherited from Object)
IsCollectionLoaded(Object) Indicates whether a particular collection is loaded with objects from the database.
IsDeletedObject(Object) Indicates whether the specified persistent object is deleted and this is committed to the database.
IsDeletionDeferredType(Type) Returns a value that indicates if the deferred deletion is enabled for persistent objects of a given type.
IsDisposedObject(Object) Determines whether an object has been disposed of.
IsIntermediateObject(Object)
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.
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) Indicates whether the specified object has been deleted but not committed in the transaction currently in progress.
IsObjectToSave(Object) Indicates whether the specified object has been added, deleted or modified, but not committed in the transaction currently in progress.
MemberwiseClone() protected Creates a shallow copy of the current Object.
(Inherited from Object)
ObjectKeyValuesEqual(ITypeInfo, Object, Object) static
(Inherited from BaseObjectSpace)
ParseCriteria(String) Parses the specified criteria expression in the XPObjectSpace's XPObjectSpace.Session.
PreFetchAsync(Object, String[], CancellationToken) Asynchronously forces associated collection data loading and delayed property loading for specified parent objects.
RaiseObjectPropertyChanged(Object, String) This method is intended for internal use.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance.
(Inherited from Object)
Refresh() Updates the persistent objects belonging to the current Object Space.
(Inherited from BaseObjectSpace)
ReloadCollection(Object) Clears a collection, and marks it to be reloaded with data from the database.
ReloadObject(Object) Reloads the state of the specified persistent object and its aggregated objects from the data store.
ReloadObjectAsync(Object, CancellationToken) Asynchronously reloads the state of the specified persistent object and its aggregated objects from the data store.
RemoveFromModifiedObjects(Object) Removes the specified object from the list of objects to be committed.
Rollback(Boolean) Cancels the changes made to the persistent objects belonging to the current Object Space.
(Inherited from BaseObjectSpace)
SetCollectionSorting(Object, IList<SortProperty>) Applies the specified sorting to a given collection.
SetDisplayableProperties(Object, String) Sets the properties to be visible by the specified collection.
SetModified(Object) Sets the state of the specified object to be Modified.
(Inherited from BaseObjectSpace)
SetModified(Object, IMemberInfo) Sets the state of the specified object to be Modified.
(Inherited from BaseObjectSpace)
SetPrefetchPropertyNames(Object, String[])
SetTopReturnedObjectsCount(Object, Int32) Sets the maximum number of objects that can be retrieved from the specified collection in a data store.
ToListAsync<T>(Object, CancellationToken) Asynchronously enumerates all elements in a collection and saves them to a list.
ToString() Returns a string that represents the current object.
(Inherited from Object)
TryGetObjectHandle(Object, out String) Creates a handle for the specified object if this object is persistent and is not a new one.

Events

Name Description
Committed Raised after saving changes made to persistent objects belonging to the current Object Space to the database.
(Inherited from BaseObjectSpace)
Committing Occurs before saving the persistent objects belonging to the current Object Space to the database.
(Inherited from BaseObjectSpace)
ConfirmationRequired Occurs when performing refresh or rollback operations with the current Object Space's persistent objects.
(Inherited from BaseObjectSpace)
Connected Occurs after a connection to a database has been established.
(Inherited from BaseObjectSpace)
CustomCommitChanges Replaces the default process for committing changes made to persistent objects with a custom one.
(Inherited from BaseObjectSpace)
CustomDeleteObjects Occurs to replace the default process of deleting persistent objects with a custom one.
(Inherited from BaseObjectSpace)
CustomRefresh Occurs to replace the default process of refreshing persistent objects with a custom one.
(Inherited from BaseObjectSpace)
CustomRollBack Occurs to replace the default process of persistent objects rollback with a custom one.
(Inherited from BaseObjectSpace)
Disposed Occurs before an Object Space is disposed of.
(Inherited from BaseObjectSpace)
ModifiedChanged Occurs when the current Object Space's BaseObjectSpace.IsModified state is changed.
(Inherited from BaseObjectSpace)
ObjectChanged Raised when a persistent object is created, changed or deleted.
(Inherited from BaseObjectSpace)
ObjectDeleted Occurs after the specified objects have been deleted.
(Inherited from BaseObjectSpace)
ObjectDeleting Occurs when the specified objects are about to be deleted.
(Inherited from BaseObjectSpace)
ObjectEndEdit Occurs after ending an edit operation taking place on the specified object.
(Inherited from BaseObjectSpace)
ObjectReloaded Occurs after an object has been reloaded from the database.
(Inherited from BaseObjectSpace)
ObjectSaved Occurs after saving changes made to a specified persistent object to the database.
(Inherited from BaseObjectSpace)
ObjectSaving Raised before saving changes made to a specified persistent object to the database.
(Inherited from BaseObjectSpace)
Refreshing Occurs before refreshing the current Object Space's persistent objects.
(Inherited from BaseObjectSpace)
Reloaded Occurs when the BaseObjectSpace.Rollback or BaseObjectSpace.Refresh method is called.
(Inherited from BaseObjectSpace)
RollingBack Occurs before rolling back the changes made to the current Object Space's persistent objects.
(Inherited from BaseObjectSpace)
See Also