Back to Devexpress

DevExpress.Xpo Namespace

xpo-devexpress.md

latest27.0 KB
Original Source

DevExpress.Xpo Namespace

Contains classes that support the infrastructure of the eXpress Persistent Objects.

Assemblies : DevExpress.DataAccess.v25.2.dll, DevExpress.Xpo.v25.2.dll

NuGet Packages : DevExpress.DataAccess, DevExpress.Xpo

Classes

NameDescription
AggregatedAttributeIndicates that persistent objects referenced by the target property are aggregated.
AssociationAttributeIdentifies the end of an association that is involved in an object relationship.
ColumnDbDefaultValueAttributeApplied to persistent class’ fields or properties. Specifies the SQL expression representing the default value of the database column mapped to the target property/field.
ColumnDefaultValueAttributeApplied to persistent class’ fields or properties. Specifies the default value of the database column mapped to the target property/field.
CommitObjectStubsResultResults of object saving performed via ISerializableObjectLayer objects.
CustomAttributeSpecifies a custom attribute for a class or a class member.
CustomCriteriaManager staticA manager for custom criteria used in LINQ to XPO expressions.
DataViewPropertiesCollectionA collection of DataViewProperty objects.
DataViewPropertyA data view column.
DataViewRecordA record within the XPDataView.
DbTypeAttributeSpecifies the database type of the column that a property is mapped to.
DefaultMembersPersistenceAttributeSpecifies which members are implied as persistent by default.
DeferredDeletionAttributeEnables deferred object deletion.
DelayedAttributeIndicates that the property’s value should not be loaded when a persistent object is being loaded. The property will be loaded the first time it is accessed.
DisplayNameAttributeSpecifies the member’s display name.
ExplicitLoadingAttributeSpecifies that the information used to retrieve persistent objects that are referenced by the current property, is included in a query used to load this property.
ExplicitUnitOfWorkThe ‘unit of work’ that uses long database level transaction to allow you to simplify the management of object changes and to access modified objects without having to commit the changes beforehand.
FetchOnlyAttributeApplied to persistent properties and fields. When applied, specifies that the target property or field value can be loaded from the database but should not be saved (should not be included in the INSERT and UPDATE SQL statements).
GetObjectStubsByKeyQueryContains essential information on a query which retrieves persistent objects by their key values via ISerializableObjectLayer objects.
IndexedAttributeIndicates that a property or field affects index creation.
IndicesAttributeSpecifies the properties that affect the creation of non-unique database indices.
KeyAttributeIndicates that a property or a field is a key.
ManyToManyAliasAttributeApplied to properties. Binds parts of the many-to-many relationship defined with an intermediate object.
MapInheritanceAttributeSpecifies the type of object-relational inheritance mapping for the class.
MemberDesignTimeVisibilityAttributeSpecifies whether a property or class is visible at design time.
MergeCollisionBehaviorAttributeApplied to persistent properties. Specifies the merge collision behavior for the target property.
NestedUnitOfWorkA nested unit of work.
NoForeignKeyAttributeDisables automatic creation of the FOREIGN KEY constraints.
NonPersistentAttributeIndicates that a class, property, or field will not be stored in a persistent data store.
NullableAttributeApplies to persistent class’ fields or properties. Specifies if a nullable column should be created when updating the database schema for the target property/field.
NullableBehaviorAttributeApplied to persistent classes. Specifies if nullable columns should be created when updating the database schema for the target class.
NullValueAttributeAssociates a constant with the null value of a property or a field of a simple type.
ObjectChangeEventArgsProvides data for the XPBaseObject.Changed and Session.ObjectChanged events.
ObjectManipulationEventArgsProvides data for the object manipulating events.
ObjectsByKeyQueryProvides data for queries that retrieve persistent objects by key values.
ObjectsManipulationEventArgsProvides data for object manipulation events.
ObjectsQueryContains essential information on an object query.
ObjectStubsQueryContains information on queries passed via ISerializableObjectLayer objects.
OptimisticLockingAttributeSpecifies that a persistent object’s state can be locked during a session.
OptimisticLockingIgnoredAttributeApplied to persistent properties. Disables the optimistic locking for the target property.
OptimisticLockingReadBehaviorAttributeSpecifies the field-level optimistic locking settings of a persistent object.
PersistentAliasAttributeIndicates that a property is not persistent and its value is calculated based upon the values of a specific field(s).
PersistentAttributeIndicates that a property, field or class will be stored in a persistent data store and specifies the target column or table name.
PersistentBaseServes as a base for classes that represent persistent objects.
ResolveSessionEventArgsProvides data for an object’s ResolveSession event.
SchemaInitEventArgsProvides data for the IDataLayer.SchemaInit event.
SerializableObjectLayerAn object access layer used for units of work (or sessions) in distributed applications.
SerializableObjectLayerClientAn object access layer that saves and loads persistent objects via an object implementing the ISerializableObjectLayer interface.
ServerExceptionThrownEventArgsProvides data for an object’s XPServerCollectionSource.ServerExceptionThrown event.
ServerViewPropertiesCollectionA collection of ServerViewProperty objects.
ServerViewPropertyThe ServerViewProperty stores information that specifies values to be loaded from the data server - property names, criteria, and sort order.
SessionThe session that is used to load and save persistent objects.
SessionManipulationEventArgsProvides data for all session handling events.
SessionOperationFailEventArgsProvides data for a session’s Session.FailedCommitTransaction and Session.FailedFlushChanges events.
SimpleDataLayerImplements a data layer that enables the object metadata to be modified at runtime.
SimpleObjectLayerAn object access layer that saves and loads persistent objects via a data access layer associated with a data store provider (an IDataStore implementation).
SizeAttributeSpecifies the maximum number of characters that can be stored in a column which is created to store the data of a property or field.
SortingCollectionA collection of SortProperty objects.
ThreadSafeDataLayerImplements a data layer that allows multiple threads to access data in a data store at the same time.
UnitOfWorkMaintains a list of persistent objects that are affected by a transaction. Keeps track of every change to every persistent object during a transaction that can affect a data store.
ValueConverterAttributeSpecifies that a property is made persistent using a Value Converter.
ViewPropertiesCollectionA collection of ViewProperty objects.
ViewPropertyA view column.
ViewRecordA record within the XPView.
XPBaseCollectionAn ancestor of the XPCollection class.
XPBaseObjectServes as a base for classes that represent persistent objects.
XPBindingSourceA binding source that binds data from a data source to a control.
XPClassInfoStubA container for persistent class metadata passed via ISerializableObjectLayer objects.
XPCollectionThe collection of persistent objects that implements delayed loading and can serve as a data source for a data-aware control.
XPCollection<T>A generic type collection of persistent objects.
XPCollectionChangedEventArgsProvides data for the XPBaseCollection.CollectionChanged event.
XPCursorA pageable collection of persistent objects.
XPCustomObjectImplements the IXPObject and provides a custom key definition.
XPDataObjectThis member supports the .NET Framework infrastructure and cannot be used directly from your code.
XPDataViewThe data source that displays data from result sets.
XPDelayedPropertyA delayed property. The delayed property will be loaded the first time it is accessed.
XPDictionaryStubA container for persistent class metadata providers passed via ISerializableObjectLayer objects.
XPInstantFeedbackSourceThe data source for a GridControl and SearchLookUpEdit controls that binds these controls to data in Instant Feedback Mode.
XPInstantFeedbackViewA data source that binds DevExpress grid controls with data tables and allows retrieving data from the server side in InstantFeedback mode.
XPLiteObjectImplements the IXPObject.
XPObjectImplements the IXPObject and provides an autogenerated integer key mapped to the ‘OID’ field.
XPObjectSourceEnables binding reports to XPO persistent class’ data.
XPObjectSourcePropertiesCollectionA collection of XPObjectSourceProperty objects.
XPObjectSourcePropertyStores information on persistent object’s properties loaded to XPObjectSource.
XPObjectSourceRecordRepresents a data record in an XPObjectSource.
XPObjectStubA container for object data passed via the ISerializableObjectLayer objects.
XPObjectStubCollectionA collection of XPObjectStub objects passed via ISerializableObjectLayer objects.
XPObjectTypeProvides object type information for a complex inheritance hierarchy. XPO automatically updates the information on the object types declared in your object model.
XpoDataSourceA data source control that is a collection of persistent objects for ASP.NET controls.
XpoDataSourceInsertedEventArgsProvides data for the XpoDataSource.Inserted event.
XpoDefault staticProvides global settings.
XPPageSelectorPresents the XPCollection as a pageable collection.
XPQuery<T>A query that allows the construction of LINQ queries for persistent objects.
XPQueryBaseServes as the base class for the XPQuery<T> class. Intended for internal use.
XPQueryExtensions staticProvides extension methods to work with XPQuery<T> objects.
XPServerCollectionSourceThe data source for a GridControl and GridLookUpEdit controls that binds these controls to data in Server Mode.
XPServerModeViewA data source that binds DevExpress grid controls with data tables and allows retrieving data from the server side.
XPViewThe view that stores data retrieved from persistent objects.
XPWeakReferenceA persistent weak reference to a persistent object.

Interfaces

NameDescription
ICustomAggregateQueryableThe interface that must be implemented by classes that provide information on custom aggregate functions to use in LINQ to XPO expressions.
ICustomCriteriaOperatorQueryableThe interface which must be implemented by classes that provide information on custom criteria to use in LINQ to XPO expressions.
ICustomFunctionOperatorQueryableThe interface which must be implemented by classes that provide information on custom functions to use in LINQ to XPO expressions.
IDataLayerThe interface to which data access layers should conform.
IDataLayerAsyncDeclares asynchronous methods for data access layers.
IObjectLayerThe interface to which object access layers should conform.
IObjectLayerAsyncDeclares asynchronous methods for an object access layer.
IObjectLayerExDefines members providing backward compatibility for sessions that directly accessed corresponding IDataLayer members in previous XPO versions.
IObjectLayerOnSessionDefines methods for object access layers created for nested units of work and units of work (or sessions) created in client applications based on ISerializableObjectLayerEx implementations.
ISerializableObjectLayerDefines essential members for object access layers created for units of work (or sessions) in distributed applications.
ISerializableObjectLayerExDefines additional members for object access layers created for units of work (or sessions) in distributed applications.
IXPModificationsStoreImplemented by classes that store information about the modified properties.
IXPObjectThe interface that provides the essential functionality for persistent objects.
IXPSimpleObjectThe interface that provides the basic functionality required by persistent objects.

Structs

NameDescription
LoadDataMemberOrderItemContains mapping information for class members and result set columns.

Delegates

NameDescription
AsyncCommitCallbackRepresents a method that will handle asynchronous COMMIT operations.
AsyncSelectDataCallbackRepresents a method that will handle operations that asynchronously retrieve objects from a data store.
ObjectChangeEventHandlerRepresents a method that will handle the XPBaseObject.Changed event.
ObjectManipulationEventHandlerRepresents a method that will handle events that process a persistent object.
ObjectsManipulationEventHandlerRepresents a method that will handle a session’s Session.ObjectsLoaded and Session.ObjectsSaved events.
ResolveSessionEventHandlerRepresents a method that will handle an object’s ResolveSession event.
SchemaInitEventHandlerRepresents a method that will handle the DevExpress.Xpo.Session.SchemaInit event.
ServerExceptionThrownEventHandlerRepresents a method that will handle the XPServerCollectionSource.ServerExceptionThrown event.
SessionManipulationEventHandlerRepresents a method that will handle the session events (e.g. Session.BeforeBeginTransaction, Session.AfterBeginTransaction events).
SessionOperationFailEventHandlerA method that will handle a session’s Session.FailedCommitTransaction and Session.FailedFlushChanges events.
XPCollectionChangedEventHandlerRepresents a method that will handle the XPBaseCollection.CollectionChanged event.
XpoDataSourceInsertedEventHandlerRepresents a method that will handle the XpoDataSource.Inserted event.

Enums

NameDescription
CollectionBindingBehaviorContains values that specify which operations can be performed on a collection.
DefaultMembersPersistenceLists the values that determine which members are implied as persistent by default.
GuidGenerationModeContains values that specify how XPO generates new globally unique identifier values.
IdentityMapBehaviorDefines how references to instances of persistent objects are stored in a session’s Identity Map.
LockingOptionLists the values that control the persistent object’s locking during a session.
MapInheritanceTypeLists the values that specify which table persistent properties and fields are saved to.
NullableBehaviorContains values specifying if a nullable column should be created when updating the database schema.
ObjectChangeReasonLists the values that indicate the way in which the object has been changed.
OptimisticLockingBehaviorContains values that specify the field-level locking behavior.
OptimisticLockingReadBehaviorLists the values that specify how XPO behaves when reloading changed objects (objects with different versions).
OptimisticLockingReadMergeBehaviorLists the values that specify how XPO behaves when merging changed objects (objects with different versions).
PersistentCriteriaEvaluationBehaviorLists values that specify how filter criteria are evaluated within a transaction.
ServerExceptionThrownActionLists the values that specify how to handle an exception thrown by a data server in Server Mode.
SortDirectionLists the values that specify the sort order.
XPCollectionChangedTypeLists the values that specify how the collection has been changed.