All docs
V20.2
20.2
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

CompositeObjectSpace Members

The base class for Object Spaces.

Constructors

Name Description
CompositeObjectSpace(ITypesInfo, IEntityStore) Initializes a new instance of the CompositeObjectSpace class with specified settings.

Fields

Name Description
AutoCommitAdditionalObjectSpacesByDefault static Specifies 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.
AutoDisposeAdditionalObjectSpacesByDefault static Specifies 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.
AutoRefreshAdditionalObjectSpacesByDefault static Specifies 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.
CompositeKeyPropertyType static For internal use. Inherited from BaseObjectSpace.
SuppressAdditionalObjectSpaceOwnerCheck For internal use.
ThrowExceptionForNotRegisteredEntityType static Certain 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

Name Description
AdditionalObjectSpaces Gets the list of Object Spaces used to handle objects that do not belong to the current Object Space. You can use the PopulateAdditionalObjectSpaces(XafApplication) method to populate this collection automatically.
AutoCommitAdditionalObjectSpaces Specifies 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.
AutoDisposeAdditionalObjectSpaces Specifies whether the current Object Space disposes of its inner Object Spaces from the AdditionalObjectSpaces collection when it disposes itself.
AutoRefreshAdditionalObjectSpaces Specifies whether the current Object Space refreshes its inner Object Spaces from the AdditionalObjectSpaces collection when it refreshes itself.
CanFilterByNonPersistentMembers For internal use. Inherited from BaseObjectSpace.
Connection Gets the connection to the underlying data source. Inherited from BaseObjectSpace.
Database Gets the name of the database. Inherited from BaseObjectSpace.
IsCommitting Indicates whether the Object Space is currently committing the changes made to its object(s). Inherited from BaseObjectSpace.
IsConnected Indicates whether the BaseObjectSpace is connected to the database. Inherited from BaseObjectSpace.
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 in the current object context. Inherited from BaseObjectSpace.
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.
TypesInfo Gets information on the business classes added to the Application Model (see IModelBOModel). Inherited from BaseObjectSpace.

Methods

Name Description
ApplyCriteria(Object, CriteriaOperator) Filters the specified collection according to the specified criteria on the server side.
ApplyFilter(Object, CriteriaOperator) Filters the specified collection according to the specified criteria on the client side.
CanApplyCriteria(Type) Indicates whether collections of a specified type can be filtered on the server side.
CanApplyFilter(Object) Indicates whether collections of a specified type can be filtered on the client side.
CanInstantiate(Type) Indicates whether instances of a particular type can be created.
CommitChanges() Saves all the changes made to the persistent objects belonging to the current Object Space to the database. Inherited from BaseObjectSpace.
CompleteAllTasksAsync() For internal use. Inherited from BaseObjectSpace.
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.
CreateByKeyCriteria(ITypeInfo, Object) static For internal use. 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) Creates an InstantFeedback mode collection that contains the specified type objects filtered according to the criteria.
CreateNestedObjectSpace() Creates a nested Object Space. Inherited from BaseObjectSpace.
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() Used when parsing a CriteriaOperator represented by a string and containing persistent objects. Inherited from BaseObjectSpace.
CreateServerCollection(Type, CriteriaOperator) Creates and initializes a new instance of the EFServerCollection or XPServerCollectionSource class with criteria-specific options.
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 the current CompositeObjectSpace object uses.
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) 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. Inherited from BaseObjectSpace.
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 that 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.
FindObjectSpaceByObject(Object) static Returns 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>>) Searches for the first object that matches the specified lambda expression. The generic parameter determines the object's type. Inherited from BaseObjectSpace.
FirstOrDefault<ObjectType>(Expression<Func<ObjectType, Boolean>>, Boolean) Searches for the first object that matches the specified expression.
GetAssociatedCollectionCriteria(Object, IMemberInfo) Returns the criteria applied to a specific object's associated collection property. Inherited from BaseObjectSpace.
GetCollectionObjectType(Object) Inherited from BaseObjectSpace.
GetCollectionSorting(Object) Returns the sort settings for a particular collection. Inherited from BaseObjectSpace.
GetCriteria(Object) Returns the criteria used to filter a specified collection on the server side.
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.
GetIntermediateObjectReferences(Object, out Object, out Object) For internal use. Inherited from BaseObjectSpace.
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 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. Inherited from BaseObjectSpace.
GetListServer(Object) For internal use. 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) Returns the object whose key property has the specified value.
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.
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 that satisfy the specified criteria.
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 the specified 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. Inherited from BaseObjectSpace.
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. Inherited from BaseObjectSpace.
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. Inherited from BaseObjectSpace.
GetType() Gets the Type of the current instance. Inherited from Object.
IsAdditionalKnownType(Type) Indicates whether any Object Space from the AdditionalObjectSpaces collection can handle objects of the specified type.
IsCollectionLoaded(Object) For internal use.
IsDeletedObject(Object) Indicates whether the specified persistent object is deleted from the database. Inherited from BaseObjectSpace.
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.
IsIntermediateObject(Object) For internal use. Inherited from BaseObjectSpace.
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. Inherited from BaseObjectSpace.
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) Indicates whether the specified object has been deleted but not committed in the current object context or the transaction currently in progress. Inherited from BaseObjectSpace.
IsObjectToSave(Object) Indicates whether the specified object has been added, deleted or modified, but not committed in the current object context or the transaction currently in progress. Inherited from BaseObjectSpace.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ObjectKeyValuesEqual(ITypeInfo, Object, Object) static Inherited from BaseObjectSpace.
ParseCriteria(String) Tries to convert the specified string representation of an expression to its CriteriaOperator equivalent. Inherited from BaseObjectSpace.
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.
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 the specified collection. Inherited from BaseObjectSpace.
ReloadObject(Object) Updates the specified object in the current Object Space with data from the data source.
RemoveFromModifiedObjects(Object) Removes the specified object from the object context or the list of objects to be committed. Inherited from BaseObjectSpace.
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. Inherited from BaseObjectSpace.
SetDisplayableProperties(Object, String) Changes the properties considered visible by a particular collection. Inherited from BaseObjectSpace.
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[]) Inherited from BaseObjectSpace.
SetTopReturnedObjectsCount(Object, Int32) Sets the maximum number of objects that can be retrieved from the specified collection in a data store. Inherited from BaseObjectSpace.
ToString() Returns a string that represents the current object. Inherited from Object.

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.
ModifiedChanging Occurs before the IsModified property is changed to true. Handle this event to cancel or force the IsModified property to change. 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