Class Session

Namespace

DevExpress.Xpo

Assembly

DevExpress.Xpo.v24.1.dll

The session that is used to load and save persistent objects.

public class Session : Component, IComponent, IDisposable, ISupportInitialize, IPersistentValueExtractor, ISessionProvider, IObjectLayerProvider, IDataLayerProvider, IXPDictionaryProvider, IWideDataStorage, ICommandChannel, ICommandChannelAsync

Inheritance

object

MarshalByRefObject

Component

Session

Implements

IComponent

IDisposable

ISupportInitialize

IPersistentValueExtractor

ISessionProvider

IObjectLayerProvider

IDataLayerProvider

IXPDictionaryProvider

IWideDataStorage

ICommandChannel

ICommandChannelAsync

Derived

DefaultSession

UnitOfWork

Inherited Members

Component.Dispose()

Component.GetService(Type)

Component.CanRaiseEvents

Component.Events

Component.Site

Component.Container

Component.DesignMode

Component.Disposed

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

XpoObjectInCriteriaProcessingHelper.CreateParseCriteriaSessionScope(Session)

XpoObjectInCriteriaProcessingHelper.ParseCriteria(Session, string, out OperandValue[])

XpoObjectInCriteriaProcessingHelper.ParseCriteria(Session, string, params object[])

XPQueryExtensions.Query<T>(Session)

XPQueryExtensions.QueryInTransaction<T>(Session)

Constructors

Session()

Initializes a new instance of the Session class with default settings.

public Session()

Session(IDataLayer, params IDisposable[])

Initializes a new instance of the Session class and connects it to a data store.

public Session(IDataLayer layer, params IDisposable[] disposeOnDisconnect)

Parameters

layer IDataLayer

An object which implements the IDataLayer interface. This value is assigned to the Session.DataLayer property.

disposeOnDisconnect IDisposable[]

An array of objects that implement the System.IDisposable interface. These objects are automatically disposed of when the session is disconnected.

Session(IObjectLayer, params IDisposable[])

Initializes a new instance of the Session class with specified settings and connects it to a data store.

public Session(IObjectLayer layer, params IDisposable[] disposeOnDisconnect)

Parameters

layer IObjectLayer

An object implementing the IObjectLayer interface. This value is assigned to the Session.ObjectLayer property.

disposeOnDisconnect IDisposable[]

An array of objects that implement the IDisposable interface. These objects are automatically disposed of when the session is disconnected.

Session(XPDictionary)

Initializes a new Session instance using the specified metadata provider.

public Session(XPDictionary dictionary)

Parameters

dictionary XPDictionary

An XPDictionary object, which is the metadata provider to be used by the newly instantiated session. This value is assigned to the Session.Dictionary property.

Session(IContainer)

Initializes a new instance of the Session class and adds it to a form’s container.

public Session(IContainer container)

Parameters

container IContainer

An IContainer object, which is the owner container of the created Session instance.

Session(IServiceProvider)

Initializes a new instance of the Session class with specified settings.

public Session(IServiceProvider serviceProvider)

Parameters

serviceProvider IServiceProvider

An object that implements the IServiceProvider interface. This object is assigned to the Session.ServiceProvider property.

Session(IServiceProvider, IDataLayer, params IDisposable[])

Initializes a new instance of the Session class with specified settings.

public Session(IServiceProvider serviceProvider, IDataLayer layer, params IDisposable[] disposeOnDisconnect)

Parameters

serviceProvider IServiceProvider

An object that implements the IServiceProvider interface. This object is assigned to the Session.ServiceProvider property.

layer IDataLayer

An object which implements the IDataLayer interface. This value is assigned to the Session.DataLayer property.

disposeOnDisconnect IDisposable[]

An array of objects that implement the System.IDisposable interface. These objects are automatically disposed of when the session is disconnected.

Session(IServiceProvider, IObjectLayer, params IDisposable[])

Initializes a new instance of the Session class with specified settings.

public Session(IServiceProvider serviceProvider, IObjectLayer layer, params IDisposable[] disposeOnDisconnect)

Parameters

serviceProvider IServiceProvider

An object that implements the IServiceProvider interface. This object is assigned to the Session.ServiceProvider property.

layer IObjectLayer

An object which implements the IObjectLayer interface. This value is assigned to the Session.ObjectLayer property.

disposeOnDisconnect IDisposable[]

An array of objects that implement the System.IDisposable interface. These objects are automatically disposed of when the session is disconnected.

Session(IServiceProvider, XPDictionary)

Initializes a new instance of the Session class with specified settings.

public Session(IServiceProvider serviceProvider, XPDictionary dictionary)

Parameters

serviceProvider IServiceProvider

An object that implements the IServiceProvider interface. This object is assigned to the Session.ServiceProvider property.

dictionary XPDictionary

An XPDictionary object, which is the metadata provider to be used by the newly instantiated session. This value is assigned to the Session.Dictionary property.

Session(IServiceProvider, IContainer)

Initializes a new instance of the Session class with specified settings.

public Session(IServiceProvider serviceProvider, IContainer container)

Parameters

serviceProvider IServiceProvider

An object that implements the IServiceProvider interface. This object is assigned to the Session.ServiceProvider property.

container IContainer

An IContainer object, which is the owner container of the created Session instance.

Fields

LogCategory

The name of a category used to tag Session and UnitOfWork operations in XPO logs. The default category name is “Session”.

public const string LogCategory = "Session"

Field Value

string

LogParam_AlwaysGetFromDataStore

Contains the name of the log parameter that specifies whether to always reload objects from a data store even if they are found in memory.

public const string LogParam_AlwaysGetFromDataStore = "alwaysGetFromDataStore"

Field Value

string

LogParam_ClassInfo

Contains the name of the log parameter that specifies the full name of a persistent class.

public const string LogParam_ClassInfo = "classInfo"

Field Value

string

LogParam_Condition

Contains the name of the log parameter that specifies the criteria for retrieving objects not yet persisted to the datastore.

public const string LogParam_Condition = "condition"

Field Value

string

LogParam_Criteria

Contains the name of the log parameter that specifies the object to be retrieved from the storage.

public const string LogParam_Criteria = "criteria"

Field Value

string

LogParam_CriteriaEvaluationBehavior

Contains the name of the log parameter that specifies how filter criteria are evaluated within a transaction.

public const string LogParam_CriteriaEvaluationBehavior = "criteriaEvaluationBehavior"

Field Value

string

LogParam_Expression

Contains the name of the log parameter that specifies an expression to be evaluated.

public const string LogParam_Expression = "expression"

Field Value

string

LogParam_GroupCriteria

Contains the name of the log parameter that specifies the grouping criteria for the retrieved persistent objects.

public const string LogParam_GroupCriteria = "groupCriteria"

Field Value

string

LogParam_GroupProps

Contains the name of the log parameter that specifies grouping properties.

public const string LogParam_GroupProps = "groupProperties"

Field Value

string

LogParam_InTransaction

Contains the name of the log parameter that specifies whether in memory object changes are taken into account when evaluating an expression.

public const string LogParam_InTransaction = "inTransaction"

Field Value

string

LogParam_IsInTransactionMode

Contains the name of the log parameter that specifies whether querying a data store for objects includes all in-memory changes into query results.

public const string LogParam_IsInTransactionMode = "IsInTransactionMode"

Field Value

string

LogParam_Members

Contains the name of the log parameter that specifies mapping information for persistent class metadata and a stored procedure’s result set columns.

public const string LogParam_Members = "members"

Field Value

string

LogParam_ObjectID

Contains the name of the log parameter that specifies an object identifier.

public const string LogParam_ObjectID = "objectID"

Field Value

string

LogParam_Objects

Contains the name of the log parameter that specifies persistent objects.

public const string LogParam_Objects = "objects"

Field Value

string

LogParam_Parameters

Contains the name of the log parameter that specifies SQL query parameters.

public const string LogParam_Parameters = "parameters"

Field Value

string

LogParam_Property

Contains the name of the log parameter that specifies a persistent object’s property.

public const string LogParam_Property = "property"

Field Value

string

LogParam_Props

Contains the name of the log parameter that specifies properties of a persistent object.

public const string LogParam_Props = "propeties"

Field Value

string

LogParam_SelectDeleted

Contains the name of the log parameter that specifies whether persistent objects marked as deleted must be retrieved.

public const string LogParam_SelectDeleted = "selectDeleted"

Field Value

string

LogParam_SessionID

Contains the name of the log parameter that specifies a session identifier.

public const string LogParam_SessionID = "sessionID"

Field Value

string

LogParam_SessionType

Contains the name of the log parameter that specifies a session type.

public const string LogParam_SessionType = "sessionType"

Field Value

string

LogParam_SkipSelectedRecords

Contains the name of the log parameter that specifies the number of persistent objects to skip.

public const string LogParam_SkipSelectedRecords = "skipSelectedRecords"

Field Value

string

LogParam_Sorting

Contains the name of the log parameter that specifies the sort order for retrieved persistent objects.

public const string LogParam_Sorting = "sorting"

Field Value

string

LogParam_SprocName

Contains the name of the log parameter that specifies the name of a stored procedure.

public const string LogParam_SprocName = "sprocName"

Field Value

string

LogParam_Sql

Contains the name of the log parameter that specifies a SQL query.

public const string LogParam_Sql = "sql"

Field Value

string

LogParam_TheObject

Contains the name of the log parameter that specifies a persistent object.

public const string LogParam_TheObject = "theObject"

Field Value

string

LogParam_TopSelectedRecords

Contains the name of the log parameter that specifies the maximum number of persistent objects to retrieve.

public const string LogParam_TopSelectedRecords = "topSelectedRecords"

Field Value

string

dict

protected XPDictionary dict

Field Value

XPDictionary

Properties

AutoCreateOption

Gets or sets the action which is performed when the session is connected to a data store.

public AutoCreateOption AutoCreateOption { get; set; }

Property Value

AutoCreateOption

An DevExpress.Xpo.DB.AutoCreateOption enumeration value which specifies the action which is performed when the session is connected to a data store.

CaseSensitive

Gets or sets whether string comparisons evaluated by the session on the client are case-sensitive.

public bool CaseSensitive { get; set; }

Property Value

bool

true if string comparisons are case-sensitive; otherwise, false.

Connection

Gets or sets an IDbConnection object associated with the session.

public IDbConnection Connection { get; set; }

Property Value

IDbConnection

An object which implements the IDbConnection interface.

ConnectionString

Gets or sets a connection string.

public string ConnectionString { get; set; }

Property Value

string

Data store connection parameters.

DataLayer

Gets the data access layer used by the current session to access a data store.

[Browsable(false)]
public IDataLayer DataLayer { get; }

Property Value

IDataLayer

An object which implements the IDataLayer interface.

DefaultSession

Gets the pre-initialized default session for simple applications.

public static Session DefaultSession { get; }

Property Value

Session

A Session object which is the default session.

Dictionary

Gets metadata on persistent objects in a data store.

[Browsable(false)]
public virtual XPDictionary Dictionary { get; }

Property Value

XPDictionary

An XPDictionary object which provides metadata on persistent objects in a data store.

IdentityMapBehavior

Gets or sets the session’s Identity Map behavior.

public IdentityMapBehavior IdentityMapBehavior { get; set; }

Property Value

IdentityMapBehavior

An IdentityMapBehavior enumeration value that specifies the session’s Identity Map behavior.

InTransaction

Indicates whether a transaction is in progress.

[Browsable(false)]
public virtual bool InTransaction { get; }

Property Value

bool

true if a transaction is in progress; otherwise, false.

InTransactionMode

Enables the mode in which querying a data store for objects includes all in-memory changes into query results.

public static bool InTransactionMode { get; set; }

Property Value

bool

true if query results include all in-memory changes made to persistent objects; otherwise, false.

IsConnected

Gets whether the session is connected to a database.

[Browsable(false)]
public bool IsConnected { get; }

Property Value

bool

true if the session is connected to a database; otherwise, false.

IsInTransactionMode

protected virtual bool IsInTransactionMode { get; }

Property Value

bool

IsObjectModifiedOnNonPersistentPropertyChange

Specifies whether or not a persistent object is marked modified when its non-persistent property value is changed.

public bool? IsObjectModifiedOnNonPersistentPropertyChange { get; set; }

Property Value

bool?

true, if a persistent object is marked modified when its non-persistent property value is changed; otherwise - false.

IsObjectsLoading

Indicates whether persistent objects are being loaded from a data store.

[Browsable(false)]
public bool IsObjectsLoading { get; }

Property Value

bool

true if persistent objects are being loaded from a data store; otherwise, false.

IsObjectsSaving

Indicates whether persistent objects are being saved to a data store.

[Browsable(false)]
public bool IsObjectsSaving { get; }

Property Value

bool

true if persistent objects are being saved to a data store; otherwise, false.

IsUnitOfWork

protected virtual bool IsUnitOfWork { get; }

Property Value

bool

LockingOption

Gets or sets a value which controls the persistent object’s locking during a session.

public LockingOption LockingOption { get; set; }

Property Value

LockingOption

A LockingOption enumeration value which controls the persistent object’s locking during a session.

ObjectLayer

Provides access to an object access layer, which the current session uses to retrieve and update object data in a data store.

[Browsable(false)]
public IObjectLayer ObjectLayer { get; }

Property Value

IObjectLayer

An object that implements the IObjectLayer interface.

OptimisticLockingReadBehavior

Gets or sets a value which specifies how XPO behaves when reloading changed objects (objects with different versions).

public OptimisticLockingReadBehavior OptimisticLockingReadBehavior { get; set; }

Property Value

OptimisticLockingReadBehavior

An OptimisticLockingReadBehavior enumeration value that specifies how XPO behaves when reloading changed objects (objects with different versions).

ServiceProvider

Gets the service provider used by the current session to access service objects.

[Browsable(false)]
public IServiceProvider ServiceProvider { get; }

Property Value

IServiceProvider

An object that implements the IServiceProvider interface.

SuppressExceptionOnReferredObjectAbsentInDataStore

protected virtual bool SuppressExceptionOnReferredObjectAbsentInDataStore { get; }

Property Value

bool

SuppressThrowingAssociationCollectionWithDisabledLoading

Specifies whether exceptions are thrown when committing changes in a collection whose XPBaseCollection.LoadingEnabled property is set to false.

[Obsolete("Using that property will suppress detection of some potential problems with associated collections. Use it at your own risk.")]
public static bool SuppressThrowingAssociationCollectionWithDisabledLoading { get; set; }

Property Value

bool

true, to suppress exceptions; otherwise false.

TrackPropertiesModifications

Specifies whether or not the current Session tracks persistent object property modifications.

public bool TrackPropertiesModifications { get; set; }

Property Value

bool

true, if the Session tracks persistent object property modifications; otherwise, false.

TrackingChanges

Indicates whether changes made to persistent objects are being tracked or a list of tracked changes is not empty.

[Browsable(false)]
public bool TrackingChanges { get; }

Property Value

bool

In sessions, true if changes made to persistent objects are currently being tracked; otherwise, false.In units of work, true if a list of tracked changes is not empty; otherwise, false.

TypesManager

This member supports the XPO Framework infrastructure and is not intended to be used directly from your code.

[Browsable(false)]
public XPObjectTypesManager TypesManager { get; }

Property Value

XPObjectTypesManager

Methods

BeginFlushChanges()

protected virtual IList BeginFlushChanges()

Returns

IList

BeginFlushChangesAsync(int, CancellationToken)

protected virtual Task<IList> BeginFlushChangesAsync(int asyncOperationId, CancellationToken cancellationToken = default)

Parameters

asyncOperationId int

cancellationToken CancellationToken

Returns

Task<IList>

BeginInit()

protected virtual void BeginInit()

BeginNestedUnitOfWork()

Creates a new NestedUnitOfWork.

public NestedUnitOfWork BeginNestedUnitOfWork()

Returns

NestedUnitOfWork

A NestedUnitOfWork object that represents the new nested unit of work.

BeginTrackingChanges()

Enables tracking changes made to persistent objects.

public void BeginTrackingChanges()

BeginTransaction()

Starts a transaction.

public virtual void BeginTransaction()

BulkLoad(params IXPBulkLoadableCollection[])

This method loads IXPBulkLoadableCollection objects passed as parameters.

public void BulkLoad(params IXPBulkLoadableCollection[] collections)

Parameters

collections IXPBulkLoadableCollection[]

An array of collections to be populated.

BulkLoad(params XPBaseCollection[])

This method loads XPBaseCollection objects passed as parameters.

public void BulkLoad(params XPBaseCollection[] collections)

Parameters

collections XPBaseCollection[]

An array of collections to be populated.

BulkLoadAsync(CancellationToken, params IXPBulkLoadableCollection[])

Asynchronously retrieves persistent objects to populate specified IXPBulkLoadableCollection type collections.

public Task BulkLoadAsync(CancellationToken cancellationToken = default, params IXPBulkLoadableCollection[] collections)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

collections IXPBulkLoadableCollection[]

An array of empty IXPBulkLoadableCollection type collections that receive persistent objects from a data store.

Returns

Task

A Task that populates specified collections.

BulkLoadAsync(CancellationToken, params XPBaseCollection[])

Asynchronously retrieves persistent objects to populate specified XPBaseCollection type collections.

public Task BulkLoadAsync(CancellationToken cancellationToken = default, params XPBaseCollection[] collections)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

collections XPBaseCollection[]

An array of empty XPBaseCollection type collections that receive persistent objects from a data store.

Returns

Task

A Task that populates specified collections.

CancelAsyncRequest(object)

This method is intended for internal use.

public static void CancelAsyncRequest(object asyncResult)

Parameters

asyncResult object

CollectReferencingObjects(object)

Returns a collection of persistent objects that refer to the specified object.

public ICollection CollectReferencingObjects(object target)

Parameters

target object

The target persistent object.

Returns

ICollection

A collection of persistent objects that refer to the specified object.

CollectReferencingObjects(object, PersistentCriteriaEvaluationBehavior, bool)

Returns a collection of persistent objects that refer to the specified object.

public ICollection CollectReferencingObjects(object target, PersistentCriteriaEvaluationBehavior behavior, bool selectDeleted)

Parameters

target object

The target persistent object.

behavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

selectDeleted bool

true to include persistent objects marked for deletion in the search; otherwise, false.

Returns

ICollection

A collection of persistent objects that refer to the specified object.

CommitTransaction()

Commits changes made within a transaction and completes it.

public virtual void CommitTransaction()

CommitTransactionAsync(AsyncCommitCallback)

Asynchronously commits changes made within a transaction, completes it and notifies upon completion.

public virtual object CommitTransactionAsync(AsyncCommitCallback callback)

Parameters

callback AsyncCommitCallback

An AsyncCommitCallback delegate to be called after the changes have been saved to a data store. Use a callback to store the exception information passed as a parameter, and use this information later to raise the exception again, within the original thread. Do not raise exceptions or modify persistent objects within a callback.

Returns

object

An object identifying the current asynchronous operation, intended for internal use.

CommitTransactionAsync(CancellationToken)

Asynchronously commits object changes made within a transaction, completes the transaction, and notifies upon completion.

public virtual Task CommitTransactionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that commits object changes made within a transaction and completes the transaction.

Connect()

Connects the session to a data store.

public void Connect()

Connect(IDataLayer, params IDisposable[])

Connects the session to a data store using a specified data access layer.

public void Connect(IDataLayer layer, params IDisposable[] disposeOnDisconnect)

Parameters

layer IDataLayer

An object implementing the IDataLayer interface.

disposeOnDisconnect IDisposable[]

An array of objects to be automatically disposed of when the session is disconnected from a data store.

Connect(IObjectLayer, params IDisposable[])

Connects the session to a data store using a specified object access layer.

public void Connect(IObjectLayer layer, params IDisposable[] disposeOnDisconnect)

Parameters

layer IObjectLayer

An object implementing the IObjectLayer interface. This object is assigned to the session’s Session.ObjectLayer property.

disposeOnDisconnect IDisposable[]

An array of objects to be automatically disposed of when the session is disconnected from a data store.

CreateDesignTimeDictionary(IServiceProvider)

protected static XPDictionary CreateDesignTimeDictionary(IServiceProvider provider)

Parameters

provider IServiceProvider

Returns

XPDictionary

CreateLogMessage(string, TimeSpan, params object[])

protected LogMessage CreateLogMessage(string title, TimeSpan duration, params object[] parameters)

Parameters

title string

duration TimeSpan

parameters object[]

Returns

LogMessage

CreateNestedUnitOfWork()

protected virtual NestedUnitOfWork CreateNestedUnitOfWork()

Returns

NestedUnitOfWork

CreateObjectTypeRecords()

Stores valid persistent types for all the types which are defined within the assemblies that have been loaded in the current application domain.

public void CreateObjectTypeRecords()

CreateObjectTypeRecords(params XPClassInfo[])

Stores valid persistent types for the specified persistent class metadata information.

public void CreateObjectTypeRecords(params XPClassInfo[] types)

Parameters

types XPClassInfo[]

An array of the XPClassInfo objects for which the persistent types will be stored in the metadata information.

CreateObjectTypeRecords(bool)

Stores valid persistent types for all the types which are defined within the assemblies that have been loaded in the current application domain.

public void CreateObjectTypeRecords(bool createOnlyNecessary)

Parameters

createOnlyNecessary bool

true, to create object type records only for types that require this to function properly, such as types from inheritance chains, or types utilizing deferred deletion; false, to create object type records for all persistent types.

CreateObjectTypeRecords(bool, params XPClassInfo[])

Stores valid persistent types for the specified persistent class metadata information.

public void CreateObjectTypeRecords(bool createOnlyNecessary, params XPClassInfo[] types)

Parameters

createOnlyNecessary bool

true, to create object type records only for types that require this to function properly, such as types from inheritance chains, or types utilizing deferred deletion; false, to create object type records for all persistent types.

types XPClassInfo[]

An array of the XPClassInfo objects for which the persistent types will be stored in the metadata information.

CreateObjectTypeRecords(bool, params Assembly[])

Stores valid persistent types for all the types which are defined within the specified assemblies.

public void CreateObjectTypeRecords(bool createOnlyNecessary, params Assembly[] assemblies)

Parameters

createOnlyNecessary bool

true, to create object type records only for types that require this to function properly, such as types from inheritance chains, or types utilizing deferred deletion; false, to create object type records for all persistent types.

assemblies Assembly[]

An array of assemblies which contain the class types for which the persistent types will be stored in the metadata information.

CreateObjectTypeRecords(bool, params Type[])

Stores valid persistent types for the specified class types.

public void CreateObjectTypeRecords(bool createOnlyNecessary, params Type[] types)

Parameters

createOnlyNecessary bool

true, to create object type records only for types that require this to function properly, such as types from inheritance chains, or types utilizing deferred deletion; false, to create object type records for all persistent types.

types Type[]

An array of class types for which the persistent types will be stored in the metadata information.

CreateObjectTypeRecords(params Assembly[])

Stores valid persistent types for all the types which are defined within the specified assemblies.

public void CreateObjectTypeRecords(params Assembly[] assemblies)

Parameters

assemblies Assembly[]

An array of assemblies which contain the class types for which the persistent types will be stored in the metadata information.

CreateObjectTypeRecords(params Type[])

Stores valid persistent types for the specified class types.

public void CreateObjectTypeRecords(params Type[] types)

Parameters

types Type[]

An array of class types for which the persistent types will be stored in the metadata information.

CreateObjectTypeRecordsAsync(bool, CancellationToken)

Asynchronously stores valid persistent types for all the types which are defined within the assemblies that have been loaded in the current application domain.

public Task CreateObjectTypeRecordsAsync(bool createOnlyNecessary, CancellationToken cancellationToken)

Parameters

createOnlyNecessary bool

true, to create object type records only for types that require this to function properly, such as types from inheritance chains, or types utilizing deferred deletion; false, to create object type records for all persistent types.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that stores valid persistent types for all the types which are defined within the assemblies that have been loaded in the current application domain.

CreateObjectTypeRecordsAsync(CancellationToken)

Asynchronously stores valid persistent types for all the types which are defined within the assemblies that have been loaded in the current application domain.

public Task CreateObjectTypeRecordsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that stores valid persistent types for all the types which are defined within the assemblies that have been loaded in the current application domain.

CreateObjectTypeRecordsAsync(CancellationToken, params XPClassInfo[])

Asynchronously stores valid persistent types for the specified persistent class metadata information.

public Task CreateObjectTypeRecordsAsync(CancellationToken cancellationToken, params XPClassInfo[] types)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

types XPClassInfo[]

An array of the XPClassInfo objects for which the persistent types will be stored in the metadata information.

Returns

Task

A Task that stores valid persistent types for the specified persistent class metadata information.

CreateObjectTypeRecordsAsync(CancellationToken, bool, params XPClassInfo[])

Asynchronously stores valid persistent types for the specified persistent class metadata information.

public Task CreateObjectTypeRecordsAsync(CancellationToken cancellationToken, bool createOnlyNecessary, params XPClassInfo[] types)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

createOnlyNecessary bool

true, to create object type records only for types that require this to function properly, such as types from inheritance chains, or types utilizing deferred deletion; false, to create object type records for all persistent types.

types XPClassInfo[]

An array of the XPClassInfo objects for which the persistent types will be stored in the metadata information.

Returns

Task

A Task that stores valid persistent types for the specified persistent class metadata information.

CreateObjectTypeRecordsAsync(CancellationToken, bool, params Assembly[])

Asynchronously stores valid persistent types for all the types which are defined within the specified assemblies.

public Task CreateObjectTypeRecordsAsync(CancellationToken cancellationToken, bool createOnlyNecessary, params Assembly[] assemblies)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

createOnlyNecessary bool

true, to create object type records only for types that require this to function properly, such as types from inheritance chains, or types utilizing deferred deletion; false, to create object type records for all persistent types.

assemblies Assembly[]

An array of assemblies which contain the class types for which the persistent types will be stored in the metadata information.

Returns

Task

A Task that stores valid persistent types for all the types which are defined within the specified assemblies.

CreateObjectTypeRecordsAsync(CancellationToken, bool, params Type[])

Asynchronously stores valid persistent types for the specified class types.

public Task CreateObjectTypeRecordsAsync(CancellationToken cancellationToken, bool createOnlyNecessary, params Type[] types)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

createOnlyNecessary bool

true, to create object type records only for types that require this to function properly, such as types from inheritance chains, or types utilizing deferred deletion; false, to create object type records for all persistent types.

types Type[]

An array of class types for which the persistent types will be stored in the metadata information.

Returns

Task

A Task that stores valid persistent types for the specified class types.

CreateObjectTypeRecordsAsync(CancellationToken, params Assembly[])

Asynchronously stores valid persistent types for all the types which are defined within the specified assemblies.

public Task CreateObjectTypeRecordsAsync(CancellationToken cancellationToken, params Assembly[] assemblies)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

assemblies Assembly[]

An array of assemblies which contain the class types for which the persistent types will be stored in the metadata information.

Returns

Task

A Task that stores valid persistent types for all the types which are defined within the specified assemblies.

CreateObjectTypeRecordsAsync(CancellationToken, params Type[])

Asynchronously stores valid persistent types for the specified class types.

public Task CreateObjectTypeRecordsAsync(CancellationToken cancellationToken, params Type[] types)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

types Type[]

An array of class types for which the persistent types will be stored in the metadata information.

Returns

Task

A Task that stores valid persistent types for the specified class types.

Delete(ICollection)

Deletes persistent objects and their aggregated objects from the data store.

public void Delete(ICollection objects)

Parameters

objects ICollection

A collection of persistent objects to delete from the data store.

Delete(object)

Deletes the specified persistent object and its aggregated objects from persistent storage.

public void Delete(object theObject)

Parameters

theObject object

An object which represents the persistent object to delete.

DeleteAsync(ICollection, CancellationToken)

Asynchronously deletes the specified persistent objects and their aggregated objects from the data store.

public Task DeleteAsync(ICollection objects, CancellationToken cancellationToken = default)

Parameters

objects ICollection

A collection of persistent objects to delete from the data store.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that deletes the specified persistent objects and their aggregated objects from the data store.

DeleteAsync(object, CancellationToken)

Asynchronously deletes the specified persistent object and its aggregated objects from persistent storage.

public Task DeleteAsync(object theObject, CancellationToken cancellationToken = default)

Parameters

theObject object

An object which represents the persistent object to delete.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that deletes the specified persistent object and its aggregated objects from persistent storage.

Disconnect()

Disconnects the session from a database.

public void Disconnect()

Dispose(bool)

protected override void Dispose(bool disposing)

Parameters

disposing bool

DropChanges()

Discards changes made to persistent objects and clears a list of tracked changes.

public void DropChanges()

DropIdentityMap()

Clears the Identity Map.

public void DropIdentityMap()

EndInit()

protected virtual void EndInit()

Evaluate(XPClassInfo, CriteriaOperator, CriteriaOperator)

Evaluates the specified expression for objects of the specified type.

public object Evaluate(XPClassInfo classInfo, CriteriaOperator expression, CriteriaOperator criteria)

Parameters

classInfo XPClassInfo

An XPClassInfo object that identifies the type of objects against which the expression is evaluated.

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The objects that match this criteria are used to evaluate the expression.

Returns

object

The value evaluated.

Evaluate(Type, CriteriaOperator, CriteriaOperator)

Evaluates the specified expression for objects of the specified type.

public object Evaluate(Type objectType, CriteriaOperator expression, CriteriaOperator criteria)

Parameters

objectType Type

A Type object that identifies the type of objects against which the expression is evaluated.

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The objects that match this criteria are used to evaluate the expression.

Returns

object

The value evaluated.

EvaluateAsync(XPClassInfo, CriteriaOperator, CriteriaOperator, CancellationToken)

Asynchronously evaluates the specified expression against objects of the specified type.

public Task<object> EvaluateAsync(XPClassInfo classInfo, CriteriaOperator expression, CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that identifies the type of objects against which the expression is evaluated.

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The methods evaluates the expression against objects that match these criteria.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns a value. This value is the evaluation’s result.

EvaluateAsync(Type, CriteriaOperator, CriteriaOperator, CancellationToken)

Asynchronously evaluates the specified expression against objects of the specified type.

public Task<object> EvaluateAsync(Type objectType, CriteriaOperator expression, CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

objectType Type

A Type object that identifies the type of objects against which the expression is evaluated.

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The method evaluates the expression against objects that match these criteria.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns a value. This value is the evaluation’s result.

EvaluateInTransaction(XPClassInfo, CriteriaOperator, CriteriaOperator)

Evaluates the specified expression for objects of the specified type, taking into account all in-memory object changes.

public object EvaluateInTransaction(XPClassInfo classInfo, CriteriaOperator expression, CriteriaOperator criteria)

Parameters

classInfo XPClassInfo

An XPClassInfo object that identifies the type of objects against which the expression will be evaluated.

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The objects that match this criteria (based on in-memory object changes) will be used to evaluate the expression.

Returns

object

The value evaluated.

EvaluateInTransaction(Type, CriteriaOperator, CriteriaOperator)

Evaluates the specified expression against objects of the specified type. Accounts for all in-memory object changes.

public object EvaluateInTransaction(Type objectType, CriteriaOperator expression, CriteriaOperator criteria)

Parameters

objectType Type

A Type object that identifies the type of objects against which the expression is evaluated.

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The method evaluates the expression against objects that match these criteria.

Returns

object

A value, which is the evaluation’s result.

EvaluateInTransactionAsync(XPClassInfo, CriteriaOperator, CriteriaOperator, CancellationToken)

Asynchronously evaluates the specified expression against objects of the specified type. Accounts for all in-memory object changes.

public Task<object> EvaluateInTransactionAsync(XPClassInfo classInfo, CriteriaOperator expression, CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that identifies the type of objects against which the expression is evaluated.

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The methods evaluates the expression against objects that match these criteria.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns a value. This value is the evaluation’s result.

EvaluateInTransactionAsync(Type, CriteriaOperator, CriteriaOperator, CancellationToken)

Asynchronously evaluates the specified expression against objects of the specified type. Accounts for all in-memory object changes.

public Task<object> EvaluateInTransactionAsync(Type objectType, CriteriaOperator expression, CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

objectType Type

A Type object that identifies the type of objects against which the expression is evaluated.

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The methods evaluates the expression against objects that match these criteria.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns a value. This value is the evaluation’s result.

EvaluateInTransactionAsync<ClassType>(CriteriaOperator, CriteriaOperator, CancellationToken)

Asynchronously evaluates the specified expression against objects whose type is designated by the generic parameter. Accounts for all in-memory object changes.

public Task<object> EvaluateInTransactionAsync<ClassType>(CriteriaOperator expression, CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The methods evaluates the expression against objects that match these criteria.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns a value. This value is the evaluation’s result.

Type Parameters

ClassType

The type of objects against which the expression is evaluated.

EvaluateInTransaction<ClassType>(CriteriaOperator, CriteriaOperator)

Evaluates the specified expression against objects whose type is designated by the generic parameter. Accounts for all in-memory object changes.

public object EvaluateInTransaction<ClassType>(CriteriaOperator expression, CriteriaOperator criteria)

Parameters

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to evaluate.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The method evaluates the expression against objects that match these criteria.

Returns

object

A value, which is the evaluation’s result.

Type Parameters

ClassType

The type of objects against which the expression is evaluated.

Evaluate<ClassType>(CriteriaOperator, CriteriaOperator)

Evaluates the specified expression for objects of the type designated by the specified generic type parameter.

public object Evaluate<ClassType>(CriteriaOperator expression, CriteriaOperator criteria)

Parameters

expression CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the expression to be evaluated.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator object that specifies the filter criteria. The objects that match this criteria are used to evaluate the expression.

Returns

object

The evaluated value.

Type Parameters

ClassType

The type of objects against which the expression is evaluated.

ExecuteNonQuery(string)

Executes the specified SQL statement and returns the number of rows affected.

public int ExecuteNonQuery(string sql)

Parameters

sql string

Specifies an SQL statement.

Returns

int

The number of rows affected by the executed SQL statement.

ExecuteNonQuery(string, QueryParameterCollection)

Executes the specified SQL statement and returns the number of rows affected.

public int ExecuteNonQuery(string sql, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

int

The number of rows affected by the executed SQL statement.

ExecuteNonQuery(string, object[])

Executes the specified SQL statement and returns the number of rows affected.

public int ExecuteNonQuery(string sql, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

int

The number of rows affected by the executed SQL statement.

ExecuteNonQuery(string, string[], QueryParameterCollection)

Executes the specified SQL statement and returns the number of rows affected.

public int ExecuteNonQuery(string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

int

The number of rows affected by the executed SQL statement.

ExecuteNonQuery(string, string[], object[])

Executes the specified SQL statement and returns the number of rows affected.

public int ExecuteNonQuery(string sql, string[] parameterNames, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

int

The number of rows affected by the executed SQL statement.

ExecuteNonQueryAsync(string, QueryParameterCollection, CancellationToken)

Asynchronously executes the specified SQL statement and returns the number of rows affected.

public Task<int> ExecuteNonQueryAsync(string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<int>

A Task<TResult> that returns a number of affected rows.

ExecuteNonQueryAsync(string, object[], CancellationToken)

Asynchronously executes the specified SQL statement and returns the number of rows affected.

public Task<int> ExecuteNonQueryAsync(string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<int>

A Task<TResult> that returns a number of affected rows.

ExecuteNonQueryAsync(string, CancellationToken)

Asynchronously executes the specified SQL statement and returns the number of rows affected.

public Task<int> ExecuteNonQueryAsync(string sql, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<int>

A Task<TResult> that returns a number of affected rows.

ExecuteNonQueryAsync(CancellationToken, string, string[], QueryParameterCollection)

Asynchronously executes the specified SQL statement and returns the number of rows affected.

public Task<int> ExecuteNonQueryAsync(CancellationToken cancellationToken, string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

Task<int>

A Task<TResult> that returns a number of affected rows.

ExecuteNonQueryAsync(CancellationToken, string, string[], object[])

Asynchronously executes the specified SQL statement and returns the number of rows affected.

public Task<int> ExecuteNonQueryAsync(CancellationToken cancellationToken, string sql, string[] parameterNames, object[] parameterValues)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

Task<int>

A Task<TResult> that returns a number of affected rows.

ExecuteQuery(string)

Executes the specified SQL query and returns a result set.

public SelectedData ExecuteQuery(string sql)

Parameters

sql string

Specifies an SQL statement.

Returns

SelectedData

A DevExpress.Xpo.DB.SelectedData object, specifying the query’s result set.

ExecuteQuery(string, QueryParameterCollection)

Executes the specified SQL query and returns a result set.

public SelectedData ExecuteQuery(string sql, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

SelectedData

A result set compatible with XPDataView

ExecuteQuery(string, object[])

Executes the specified SQL query and returns a result set.

public SelectedData ExecuteQuery(string sql, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

SelectedData

A DevExpress.Xpo.DB.SelectedData object, specifying the query’s result set.

ExecuteQuery(string, string[], QueryParameterCollection)

Executes the specified SQL query and returns a result set.

public SelectedData ExecuteQuery(string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

SelectedData

A result set compatible with XPDataView

ExecuteQuery(string, string[], object[])

Executes the specified SQL query and returns a result set.

public SelectedData ExecuteQuery(string sql, string[] parameterNames, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

SelectedData

A DevExpress.Xpo.DB.SelectedData object, specifying the query’s result set.

ExecuteQueryAsync(string, QueryParameterCollection, CancellationToken)

Asynchronously executes the specified SQL query and returns a result set.

public Task<SelectedData> ExecuteQueryAsync(string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns a result set compatible with XPDataView.

ExecuteQueryAsync(string, object[], CancellationToken)

Asynchronously executes the specified SQL query and returns a result set.

public Task<SelectedData> ExecuteQueryAsync(string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns a result set compatible with XPDataView.

ExecuteQueryAsync(string, string[], QueryParameterCollection, CancellationToken)

Asynchronously executes the specified SQL query and returns a result set.

public Task<SelectedData> ExecuteQueryAsync(string sql, string[] parameterNames, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns a result set compatible with XPDataView.

ExecuteQueryAsync(string, string[], object[], CancellationToken)

Asynchronously executes the specified SQL query and returns a result set.

public Task<SelectedData> ExecuteQueryAsync(string sql, string[] parameterNames, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns a result set compatible with XPDataView.

ExecuteQueryAsync(string, CancellationToken)

Asynchronously executes the specified SQL query and returns a result set.

public Task<SelectedData> ExecuteQueryAsync(string sql, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns the data retrieved from the data store.

ExecuteQueryWithMetadata(string)

Executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public SelectedData ExecuteQueryWithMetadata(string sql)

Parameters

sql string

Specifies an SQL statement.

Returns

SelectedData

A DevExpress.Xpo.DB.SelectedData object, specifying the query’s result set and the types and names of retrieved columns.

ExecuteQueryWithMetadata(string, QueryParameterCollection)

Executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public SelectedData ExecuteQueryWithMetadata(string sql, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

SelectedData

A result set compatible with XPDataView.

ExecuteQueryWithMetadata(string, object[])

Executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public SelectedData ExecuteQueryWithMetadata(string sql, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

SelectedData

A DevExpress.Xpo.DB.SelectedData object, specifying the query’s result set and the types and names of retrieved columns.

ExecuteQueryWithMetadata(string, string[], QueryParameterCollection)

Executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public SelectedData ExecuteQueryWithMetadata(string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

SelectedData

A result set compatible with XPDataView.

ExecuteQueryWithMetadata(string, string[], object[])

Executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public SelectedData ExecuteQueryWithMetadata(string sql, string[] parameterNames, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

SelectedData

A DevExpress.Xpo.DB.SelectedData object, specifying the query’s result set and the types and names of retrieved columns.

ExecuteQueryWithMetadataAsync(string, QueryParameterCollection, CancellationToken)

Asynchronously executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public Task<SelectedData> ExecuteQueryWithMetadataAsync(string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns a result set compatible with XPDataView.

ExecuteQueryWithMetadataAsync(string, object[], CancellationToken)

Asynchronously executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public Task<SelectedData> ExecuteQueryWithMetadataAsync(string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns a result set compatible with XPDataView.

ExecuteQueryWithMetadataAsync(string, string[], QueryParameterCollection, CancellationToken)

Asynchronously executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public Task<SelectedData> ExecuteQueryWithMetadataAsync(string sql, string[] parameterNames, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns a result set compatible with XPDataView.

ExecuteQueryWithMetadataAsync(string, string[], object[], CancellationToken)

Asynchronously executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public Task<SelectedData> ExecuteQueryWithMetadataAsync(string sql, string[] parameterNames, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns a result set compatible with XPDataView.

ExecuteQueryWithMetadataAsync(string, CancellationToken)

Asynchronously executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

public Task<SelectedData> ExecuteQueryWithMetadataAsync(string sql, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<SelectedData>

A Task<TResult> that returns a result set compatible with XPDataView.

ExecuteScalar(string)

Executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public object ExecuteScalar(string sql)

Parameters

sql string

Specifies an SQL statement.

Returns

object

The first column of the first row in the query’s result set. If the column is not found in the result set, a null reference (Nothing in Visual Basic) is returned. If the value in the database is null, DBNull.Value is returned.

ExecuteScalar(string, QueryParameterCollection)

Executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public object ExecuteScalar(string sql, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

object

The first column of the first row in the query’s result set. A null reference (Nothing in Visual Basic) if the result set does not contain columns. DBNull.Value if the first column does not contain a value.

ExecuteScalar(string, object[])

Executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public object ExecuteScalar(string sql, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

object

The first column of the first row in the query’s result set. If the column is not found in the result set, a null reference (Nothing in Visual Basic) is returned. If the value in the database is null, DBNull.Value is returned.

ExecuteScalar(string, string[], QueryParameterCollection)

Executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public object ExecuteScalar(string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

object

The first column of the first row in the query’s result set. A null reference (Nothing in Visual Basic) if the result set does not contain columns. DBNull.Value if the first column does not contain a value.

ExecuteScalar(string, string[], object[])

Executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public object ExecuteScalar(string sql, string[] parameterNames, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

object

The first column of the first row in the query’s result set. If the column is not found in the result set, a null reference (Nothing in Visual Basic) is returned. If the value in the database is null, DBNull.Value is returned.

ExecuteScalarAsync(string, QueryParameterCollection, CancellationToken)

Asynchronously executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public Task<object> ExecuteScalarAsync(string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task<TResult> that returns the first column of the first row in the query’s result set. A null reference (Nothing in Visual Basic) if the result set does not contain columns. DBNull.Value if the first column does not contain a value.

ExecuteScalarAsync(string, object[], CancellationToken)

Executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public Task<object> ExecuteScalarAsync(string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task<TResult> that returns the first column of the first row in the query’s result set. A null reference (Nothing in Visual Basic) if the result set does not contain columns. DBNull.Value if the first column does not contain a value.

ExecuteScalarAsync(string, string[], QueryParameterCollection, CancellationToken)

Asynchronously executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public Task<object> ExecuteScalarAsync(string sql, string[] parameterNames, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task<TResult> that returns the first column of the first row in the query’s result set. A null reference (Nothing in Visual Basic) if the result set does not contain columns. DBNull.Value if the first column does not contain a value.

ExecuteScalarAsync(string, string[], object[], CancellationToken)

Asynchronously executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public Task<object> ExecuteScalarAsync(string sql, string[] parameterNames, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task<TResult> that returns the first column of the first row in the query’s result set. A null reference (Nothing in Visual Basic) if the result set does not contain columns. DBNull.Value if the first column does not contain a value.

ExecuteScalarAsync(string, CancellationToken)

Executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

public Task<object> ExecuteScalarAsync(string sql, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task<TResult> that returns the first column of the first row in the query’s result set. A null reference (Nothing in Visual Basic) if the result set does not contain columns. DBNull.Value if the first column does not contain a value.

ExecuteSproc(string, params OperandValue[])

Executes the specified stored procedure and returns its result set.

public SelectedData ExecuteSproc(string sprocName, params OperandValue[] parameters)

Parameters

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects specifying parameters to pass to the stored procedure.

Returns

SelectedData

A DevExpress.Xpo.DB.SelectedData object specifying the result set returned by the specified stored procedure.

ExecuteSprocAsync(CancellationToken, string, params OperandValue[])

Asynchronously executes the specified stored procedure and returns its result set.

public Task<SelectedData> ExecuteSprocAsync(CancellationToken cancellationToken, string sprocName, params OperandValue[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects specifying parameters to pass to the stored procedure.

Returns

Task<SelectedData>

A Task<TResult> that returns a DevExpress.Xpo.DB.SelectedData object specifying the result set returned by the specified stored procedure.

ExecuteSprocParametrized(string, params SprocParameter[])

Executes the specified stored procedure with the named parameters and returns its result set.

public SelectedData ExecuteSprocParametrized(string sprocName, params SprocParameter[] parameters)

Parameters

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

SelectedData

A DevExpress.Xpo.DB.SelectedData object specifying the result set returned by the specified stored procedure.

ExecuteSprocParametrizedAsync(CancellationToken, string, params SprocParameter[])

Asynchronously executes the specified stored procedure with the named parameters and returns its result set.

public Task<SelectedData> ExecuteSprocParametrizedAsync(CancellationToken cancellationToken, string sprocName, params SprocParameter[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

Task<SelectedData>

A Task<TResult> that returns a DevExpress.Xpo.DB.SelectedData object specifying the result set returned by the specified stored procedure.

ExplicitBeginTransaction()

Marks the starting point of a database level transaction.

public void ExplicitBeginTransaction()

ExplicitBeginTransaction(IsolationLevel)

Marks the starting point of a database level transaction that is started with the specified IsolationLevel value.

public void ExplicitBeginTransaction(IsolationLevel isolationLevel)

Parameters

isolationLevel IsolationLevel

A IsolationLevel enumeration value, specifying the transaction locking behavior for a session’s connection.

ExplicitBeginTransactionAsync(IsolationLevel, CancellationToken)

public Task ExplicitBeginTransactionAsync(IsolationLevel isolationLevel, CancellationToken cancellationToken = default)

Parameters

isolationLevel IsolationLevel

cancellationToken CancellationToken

Returns

Task

ExplicitBeginTransactionAsync(CancellationToken)

public Task ExplicitBeginTransactionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

ExplicitCommitTransaction()

Completes a database level transaction and commits changes made within it.

public void ExplicitCommitTransaction()

ExplicitCommitTransactionAsync(CancellationToken)

Asynchronously completes a database level transaction and commits changes made within the transaction.

public Task ExplicitCommitTransactionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that commits changes made within a database level transaction and completes the transaction.

ExplicitRollbackTransaction()

Completes a database level transaction and rolls back changes made within it.

public void ExplicitRollbackTransaction()

ExplicitRollbackTransactionAsync(CancellationToken)

public Task ExplicitRollbackTransactionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

FindObject(XPClassInfo, CriteriaOperator)

Searches for the first object which matches the specified criteria.

public object FindObject(XPClassInfo classInfo, CriteriaOperator criteria)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

Returns

object

An object which represents the first persistent object which matches the specified criteria. null (Nothing in Visual Basic) if no persistent object which matches the criteria is found.

FindObject(XPClassInfo, CriteriaOperator, bool)

Searches for the first object which matches the specified criteria.

public object FindObject(XPClassInfo classInfo, CriteriaOperator criteria, bool selectDeleted)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

selectDeleted bool

true to include persistent objects marked as deleted into the search; otherwise, false.

Returns

object

An object which represents the first persistent object which matches the specified criteria. null (Nothing in Visual Basic) if no persistent object which matches the criteria is found.

FindObject(PersistentCriteriaEvaluationBehavior, XPClassInfo, CriteriaOperator)

Searches for the first object which matches the specified criteria.

public object FindObject(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, XPClassInfo classInfo, CriteriaOperator criteria)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

Returns

object

An object which represents the first persistent object which matches the specified criteria. null (Nothing in Visual Basic) if no persistent object which matches the criteria is found.

FindObject(PersistentCriteriaEvaluationBehavior, XPClassInfo, CriteriaOperator, bool)

Searches for the first object which matches the specified criteria.

public object FindObject(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, XPClassInfo classInfo, CriteriaOperator criteria, bool selectDeleted)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

selectDeleted bool

true to include persistent objects marked as deleted into the search; otherwise, false.

Returns

object

An object which represents the first persistent object which matches the specified criteria. null (Nothing in Visual Basic) if no persistent object which matches the criteria is found.

FindObject(PersistentCriteriaEvaluationBehavior, Type, CriteriaOperator)

Searches for the first object which matches the specified criteria.

public object FindObject(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, Type objType, CriteriaOperator criteria)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

objType Type

A Type object which represents the type of objects to search for.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

Returns

object

An object which represents the first persistent object which matches the specified criteria. null (Nothing in Visual Basic) if no persistent object which matches the criteria is found.

FindObject(Type, CriteriaOperator)

Searches for the first object which matches the specified criteria.

public object FindObject(Type classType, CriteriaOperator criteria)

Parameters

classType Type

A Type object which represents the type of objects to search for.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects to.

Returns

object

An object which represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object which matches the criteria is found.

FindObject(Type, CriteriaOperator, bool)

Searches for the first object which matches the specified criteria.

public object FindObject(Type classType, CriteriaOperator criteria, bool selectDeleted)

Parameters

classType Type

A Type object which represents the type of objects to search for.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects to.

selectDeleted bool

true to include persistent objects marked as deleted into the search; otherwise, false.

Returns

object

An object which represents the first persistent object which matches the specified criteria. null (Nothing in Visual Basic) if no persistent object which matches the criteria is found.

FindObjectAsync(XPClassInfo, CriteriaOperator, AsyncFindObjectCallback)

Asynchronously searches for the first object which matches the specified criteria, and notifies upon completion.

public object FindObjectAsync(XPClassInfo classInfo, CriteriaOperator criteria, AsyncFindObjectCallback callback)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

callback AsyncFindObjectCallback

A DevExpress.Xpo.Helpers.AsyncFindObjectCallback delegate to be called after the method completes.Use callback to do the following:Do not raise exceptions or modify persistent objects within a callback.

Returns

object

An object used internally to manage an asynchronous operation.

FindObjectAsync(XPClassInfo, CriteriaOperator, bool, AsyncFindObjectCallback)

Asynchronously searches for the first object which matches the specified criteria, and notifies upon completion.

public object FindObjectAsync(XPClassInfo classInfo, CriteriaOperator criteria, bool selectDeleted, AsyncFindObjectCallback callback)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

selectDeleted bool

true to include persistent objects marked for deletion into the search; otherwise, false.

callback AsyncFindObjectCallback

A DevExpress.Xpo.Helpers.AsyncFindObjectCallback delegate to be called after the method completes.Use callback to do the following:Do not raise exceptions or modify persistent objects within a callback.

Returns

object

An object used internally to manage an asynchronous operation.

FindObjectAsync(XPClassInfo, CriteriaOperator, bool, CancellationToken)

Asynchronously searches for the first object that matches the specified criteria.

public Task<object> FindObjectAsync(XPClassInfo classInfo, CriteriaOperator criteria, bool selectDeleted, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information. This data specifies which class needs to be searched.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria the persistent object must match.

selectDeleted bool

true, to include persistent objects marked as deleted into the search; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

FindObjectAsync(XPClassInfo, CriteriaOperator, CancellationToken)

Asynchronously searches for the first object that matches the specified criteria.

public Task<object> FindObjectAsync(XPClassInfo classInfo, CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information. This data specifies which class needs to be searched.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria the persistent object must match.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

FindObjectAsync(PersistentCriteriaEvaluationBehavior, XPClassInfo, CriteriaOperator, AsyncFindObjectCallback)

Asynchronously searches for the first object which matches the specified criteria, and notifies upon completion.

public object FindObjectAsync(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, XPClassInfo classInfo, CriteriaOperator criteria, AsyncFindObjectCallback callback)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

callback AsyncFindObjectCallback

A DevExpress.Xpo.Helpers.AsyncFindObjectCallback delegate to be called after the method completes.Use callback to do the following:Do not raise exceptions or modify persistent objects within a callback.

Returns

object

An object used internally to manage an asynchronous operation.

FindObjectAsync(PersistentCriteriaEvaluationBehavior, XPClassInfo, CriteriaOperator, bool, AsyncFindObjectCallback)

Asynchronously searches for the first object which matches the specified criteria, and notifies upon completion.

public object FindObjectAsync(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, XPClassInfo classInfo, CriteriaOperator criteria, bool selectDeleted, AsyncFindObjectCallback callback)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

selectDeleted bool

true to include persistent objects marked for deletion into the search; otherwise, false.

callback AsyncFindObjectCallback

A DevExpress.Xpo.Helpers.AsyncFindObjectCallback delegate to be called after the method completes.Use callback to do the following:Do not raise exceptions or modify persistent objects within a callback.

Returns

object

An object used internally to manage an asynchronous operation.

FindObjectAsync(PersistentCriteriaEvaluationBehavior, XPClassInfo, CriteriaOperator, bool, CancellationToken)

Asynchronously searches for the first object that matches the specified criteria.

public Task<object> FindObjectAsync(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, XPClassInfo classInfo, CriteriaOperator criteria, bool selectDeleted, CancellationToken cancellationToken = default)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information. This data specifies which class needs to be searched.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria the persistent object must match.

selectDeleted bool

true, to include persistent objects marked as deleted into the search; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

FindObjectAsync(PersistentCriteriaEvaluationBehavior, Type, CriteriaOperator, CancellationToken)

Asynchronously searches for the first object that matches the specified criteria.

public Task<object> FindObjectAsync(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, Type objType, CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

objType Type

A Type object which represents the type of objects to search for.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria the persistent object must match.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

FindObjectAsync(Type, CriteriaOperator, bool, CancellationToken)

Asynchronously searches for the first object that matches the specified criteria.

public Task<object> FindObjectAsync(Type classType, CriteriaOperator criteria, bool selectDeleted, CancellationToken cancellationToken = default)

Parameters

classType Type

A Type object which represents the type of objects to search for.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria the persistent object must match.

selectDeleted bool

true, to include persistent objects marked as deleted into the search; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

FindObjectAsync(Type, CriteriaOperator, CancellationToken)

Asynchronously searches for the first object that matches the specified criteria.

public Task<object> FindObjectAsync(Type classType, CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

classType Type

A Type object which represents the type of objects to search for.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria the persistent object must match.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

FindObjectAsync<ClassType>(CriteriaOperator, AsyncFindObjectCallback)

Asynchronously searches for the first object which matches the specified criteria and has the type designated by the generic type parameter, and notifies upon completion.

public object FindObjectAsync<ClassType>(CriteriaOperator criteria, AsyncFindObjectCallback callback)

Parameters

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

callback AsyncFindObjectCallback

A DevExpress.Xpo.Helpers.AsyncFindObjectCallback delegate to be called after the method completes.Use callback to do the following:Do not raise exceptions or modify persistent objects within a callback.

Returns

object

An object used internally to manage an asynchronous operation.

Type Parameters

ClassType

FindObjectAsync<ClassType>(CriteriaOperator, bool, AsyncFindObjectCallback)

Asynchronously searches for the first object which matches the specified criteria and has the type designated by the generic type parameter, and notifies upon completion.

public object FindObjectAsync<ClassType>(CriteriaOperator criteria, bool selectDeleted, AsyncFindObjectCallback callback)

Parameters

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

selectDeleted bool

true to include persistent objects marked as deleted in the search; otherwise, false.

callback AsyncFindObjectCallback

A DevExpress.Xpo.Helpers.AsyncFindObjectCallback delegate to be called after the method completes.Use callback to do the following:Do not raise exceptions or modify persistent objects within a callback.

Returns

object

An object used internally to manage an asynchronous operation.

Type Parameters

ClassType

FindObjectAsync<ClassType>(CriteriaOperator, bool, CancellationToken)

Asynchronously searches for the first object that matches the specified criteria. This object’s type is designated by the specified generic parameter.

public Task<ClassType> FindObjectAsync<ClassType>(CriteriaOperator criteria, bool selectDeleted, CancellationToken cancellationToken = default)

Parameters

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria the persistent object must match.

selectDeleted bool

true, to include persistent objects marked as deleted into the search; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ClassType>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

Type Parameters

ClassType

FindObjectAsync<ClassType>(CriteriaOperator, CancellationToken)

Asynchronously searches for the first object that matches the specified criteria. This object’s type is designated by the specified generic parameter.

public Task<ClassType> FindObjectAsync<ClassType>(CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria the persistent object must match.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ClassType>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

Type Parameters

ClassType

FindObjectAsync<ClassType>(PersistentCriteriaEvaluationBehavior, CriteriaOperator, AsyncFindObjectCallback)

Asynchronously searches for the first object which matches the specified criteria and has the type designated by the generic type parameter, and notifies upon completion.

public object FindObjectAsync<ClassType>(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, CriteriaOperator criteria, AsyncFindObjectCallback callback)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

callback AsyncFindObjectCallback

A DevExpress.Xpo.Helpers.AsyncFindObjectCallback delegate to be called after the method completes.Use callback to do the following:Do not raise exceptions or modify persistent objects within a callback.

Returns

object

An object used internally to manage an asynchronous operation.

Type Parameters

ClassType

FindObjectAsync<ClassType>(PersistentCriteriaEvaluationBehavior, CriteriaOperator, CancellationToken)

Asynchronously searches for the first object that matches the specified criteria. This object’s type is designated by the specified generic parameter.

public Task<ClassType> FindObjectAsync<ClassType>(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, CriteriaOperator criteria, CancellationToken cancellationToken = default)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria the persistent object must match.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ClassType>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

Type Parameters

ClassType

FindObject<ClassType>(CriteriaOperator)

Searches for the first object of the type designated by the specified generic type parameter which matches the specified criteria.

public ClassType FindObject<ClassType>(CriteriaOperator criteria)

Parameters

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

Returns

ClassType

An object which represents the first persistent object matching the specified criteria. null (Nothing in Visual Basic) if no persistent object matching the criteria is found.

Type Parameters

ClassType

The type of objects to search for.

FindObject<ClassType>(CriteriaOperator, bool)

Searches for the first object of the type designated by the specified generic type parameter which matches the specified criteria.

public ClassType FindObject<ClassType>(CriteriaOperator criteria, bool selectDeleted)

Parameters

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

selectDeleted bool

true to include persistent objects marked as deleted into the search; otherwise, false.

Returns

ClassType

An object which represents the first persistent object matching the specified criteria. null (Nothing in Visual Basic) if no persistent object matching the criteria is found.

Type Parameters

ClassType

The type of objects to search for.

FindObject<ClassType>(PersistentCriteriaEvaluationBehavior, CriteriaOperator)

Searches for the first object of the type designated by the specified generic type parameter which matches the specified criteria.

public ClassType FindObject<ClassType>(PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior, CriteriaOperator criteria)

Parameters

criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the criteria to match persistent objects.

Returns

ClassType

An object which represents the first persistent object matching the specified criteria. null (Nothing in Visual Basic) if no persistent object matching the criteria is found.

Type Parameters

ClassType

The type of objects to search for.

FlushChanges()

Saves changes made to persistent objects to a data store, and clears a list of tracked changes.

public void FlushChanges()

FlushChangesAsync(AsyncCommitCallback)

Asynchronously saves changes made to persistent objects to a data store, clears a list of tracked changes and notifies upon completion.

public object FlushChangesAsync(AsyncCommitCallback callback)

Parameters

callback AsyncCommitCallback

An AsyncCommitCallback delegate to be called after changes have been saved and a list of tracked changes has been cleared. This collection is passed as a parameter to callback. Use a callback to store the exception information passed as a parameter, and use this information later to raise the exception again, within the original thread. Do not raise exceptions or modify persistent objects within a callback.

Returns

object

An object identifying the current asynchronous operation, intended for internal use.

FlushChangesAsync(CancellationToken)

Asynchronously saves changes made to persistent objects to a data store and clears a tracked changes list.

public Task FlushChangesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that saves changes made to persistent objects to a data store and clears a tracked changes list.

GetClassInfo(object)

Returns the XPClassInfo for the specified persistent object.

public XPClassInfo GetClassInfo(object theObject)

Parameters

theObject object

An object which represents the persistent object.

Returns

XPClassInfo

An XPClassInfo object which provides metadata information for the specified persistent object.

GetClassInfo(string, string)

Returns the XPClassInfo for the specified assembly and class.

public XPClassInfo GetClassInfo(string assemblyName, string className)

Parameters

assemblyName string

A string value which specifies the assembly name.

className string

A string value which specifies the class name.

Returns

XPClassInfo

An XPClassInfo object which provides metadata information for the specified assembly and class.

GetClassInfo(Type)

Returns the XPClassInfo for the specified type of class.

public XPClassInfo GetClassInfo(Type classType)

Parameters

classType Type

A Type object which represents the class type.

Returns

XPClassInfo

An XPClassInfo object which provides metadata information for the class of the specified type.

GetClassInfo<ClassType>()

Returns the XPClassInfo for the type designated by the specified generic type parameter.

public XPClassInfo GetClassInfo<ClassType>()

Returns

XPClassInfo

An XPClassInfo object which provides metadata information for a class of the specified type.

Type Parameters

ClassType

GetIdentityMapBehavior()

This method is intended for internal use only.

public IdentityMapBehavior GetIdentityMapBehavior()

Returns

IdentityMapBehavior

GetKeyValue(object)

Returns the key property’s value of the specified persistent object.

public object GetKeyValue(object theObject)

Parameters

theObject object

An object which represents the persistent object whose key property’s value is returned.

Returns

object

An object which represents the key property’s value of the specified persistent object.

GetLoadedObjectByKey(XPClassInfo, object)

Returns the persistent object with the specified value of the key property that has been already loaded from a data store.

public object GetLoadedObjectByKey(XPClassInfo classInfo, object id)

Parameters

classInfo XPClassInfo

An XPClassInfo descendant that contains the metadata information of the class.

id object

An object which represents the key property’s value of the persistent object.

Returns

object

An object which represents the persistent object with the specified value of the key property. null (Nothing in Visual Basic) if the persistent object was not found in memory.

GetLoadedObjectByKey(Type, object)

Returns the persistent object with the specified value of the key property that has been already loaded from a data store.

public object GetLoadedObjectByKey(Type classType, object id)

Parameters

classType Type

The Type of the persistent object.

id object

An object which represents the key property’s value of the persistent object.

Returns

object

An object which represents the persistent object with the specified value of the key property. null (Nothing in Visual Basic) if the persistent object was not found in memory.

GetLoadedObjectByKey<ClassType>(object)

Returns the persistent object of the type designated by the specified generic type parameter, with the specified value of the key property previously loaded from a data store.

public ClassType GetLoadedObjectByKey<ClassType>(object id)

Parameters

id object

An object which represents the key property’s value of the persistent object.

Returns

ClassType

An object which represents a persistent object with the specified value of the key property. null (Nothing in Visual Basic) if the persistent object was not found in memory.

Type Parameters

ClassType

A type of objects to search for.

GetObjectByKey(XPClassInfo, object)

Returns a persistent object with the specified value of the key property.

public object GetObjectByKey(XPClassInfo classInfo, object id)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

id object

An object which represents the key property’s value of the persistent object.

Returns

object

An object which represents the persistent object with the specified value of the key property. Null if no objects are found.

GetObjectByKey(XPClassInfo, object, bool)

Returns the reloaded persistent object with the specified value of the key property from a data store.

public object GetObjectByKey(XPClassInfo classInfo, object id, bool alwaysGetFromDataStore)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

id object

An object which represents the key property’s value of the persistent object.

alwaysGetFromDataStore bool

true, to reload the persistent object from storage if it is found in memory; otherwise, false.

Returns

object

An object which represents the persistent object with the specified value of the key property. Null if no objects are found.

GetObjectByKey(Type, object)

Returns the persistent object that has the specified value for its key property.

public object GetObjectByKey(Type classType, object id)

Parameters

classType Type

A Type object which represents the type of objects to search for.

id object

An object that represents the persistent object’s key property value.

Returns

object

An object which represents the persistent object with the specified value for its key property. Null if no objects are found.

GetObjectByKey(Type, object, bool)

Returns the reloaded persistent object with the specified value of the key property from a data store.

public object GetObjectByKey(Type classType, object id, bool alwaysGetFromDataStore)

Parameters

classType Type

A Type object which represents the type of objects to search for.

id object

An object which represents the key property’s value of the persistent object.

alwaysGetFromDataStore bool

true, to reload the persistent object from storage if it is found in memory; otherwise, false.

Returns

object

An object which represents the persistent object with the specified value of the key property. Null if no objects are found.

GetObjectByKeyAsync(XPClassInfo, object, bool, CancellationToken)

Asynchronously returns a persistent object that has the specified key property value from a data store.

public Task<object> GetObjectByKeyAsync(XPClassInfo classInfo, object id, bool alwaysGetFromDataStore, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

id object

An object which represents the key property’s value of the persistent object.

alwaysGetFromDataStore bool

true, to always reload the persistent object from storage even if it is found in memory; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns a persistent object from a data store. This persistent object has the specified key property value. The task returns null if no objects are found.

GetObjectByKeyAsync(XPClassInfo, object, CancellationToken)

Asynchronously returns a persistent object that has the specified key property value.

public Task<object> GetObjectByKeyAsync(XPClassInfo classInfo, object id, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

id object

An object which represents the key property’s value of the persistent object.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns a persistent object. This persistent object has the specified key property value. The task returns null if no objects are found.

GetObjectByKeyAsync(Type, object, bool, CancellationToken)

Asynchronously returns a persistent object that has the specified key property value from a data store.

public Task<object> GetObjectByKeyAsync(Type classType, object id, bool alwaysGetFromDataStore, CancellationToken cancellationToken = default)

Parameters

classType Type

A Type object which represents the type of objects to search for.

id object

An object which represents the persistent object’s key property value.

alwaysGetFromDataStore bool

true, to always reload the persistent object from storage even if it is found in memory; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns a persistent object from a data store. This persistent object has the specified key property value. The task returns null if no objects are found.

GetObjectByKeyAsync(Type, object, CancellationToken)

Asynchronously returns a persistent object that has the specified key property value.

public Task<object> GetObjectByKeyAsync(Type classType, object id, CancellationToken cancellationToken = default)

Parameters

classType Type

A Type object which represents the type of objects to search for.

id object

An object that represents the persistent object’s key property value.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<object>

A Task that returns a persistent object. This persistent object has the specified key property value. The task returns null if no objects are found.

GetObjectByKeyAsync<ClassType>(object, bool, CancellationToken)

Asynchronously returns a persistent object that has the specified key property value. The persistent object’s type is set by the generic type parameter.

public Task<ClassType> GetObjectByKeyAsync<ClassType>(object id, bool alwaysGetFromDataStore, CancellationToken cancellationToken = default)

Parameters

id object

An object that represents the persistent object’s key property value.

alwaysGetFromDataStore bool

true, to always reload the persistent object from storage even if it is found in memory; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ClassType>

A Task that returns a persistent object from a data store. This persistent object has the specified key property value and a type specified by the generic type parameter. The task returns null if no objects are found.

Type Parameters

ClassType

A type of objects to search for.

GetObjectByKeyAsync<ClassType>(object, CancellationToken)

Asynchronously returns a persistent object that has the specified key property value. The persistent object’s type is set by the generic type parameter.

public Task<ClassType> GetObjectByKeyAsync<ClassType>(object id, CancellationToken cancellationToken = default)

Parameters

id object

An object that represents the persistent object’s key property value.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ClassType>

A Task that returns a persistent object. This persistent object has the specified key property value and a type specified by the generic type parameter. The task returns null if no objects are found.

Type Parameters

ClassType

A type of objects to search for.

GetObjectByKey<ClassType>(object)

Returns a persistent object of the type designated by the specified generic type parameter, with the specified value for its key property.

public ClassType GetObjectByKey<ClassType>(object id)

Parameters

id object

An object that represents the persistent object’s key property value.

Returns

ClassType

An object which represents a persistent object with the specified value for its key property. Null if no objects are found.

Type Parameters

ClassType

A type of objects to search for.

GetObjectByKey<ClassType>(object, bool)

Returns a persistent object of the type designated by the specified generic type parameter, with the specified value for its key property.

public ClassType GetObjectByKey<ClassType>(object id, bool alwaysGetFromDataStore)

Parameters

id object

An object that represents the persistent object’s key property value.

alwaysGetFromDataStore bool

true, to reload the persistent object from storage if it is found in memory; otherwise, false.

Returns

ClassType

An object which represents a persistent object with the specified value for its key property. Null if no objects are found.

Type Parameters

ClassType

A type of objects to search for.

GetObjectLayerAsync()

protected IObjectLayerAsync GetObjectLayerAsync()

Returns

IObjectLayerAsync

GetObjectString(object)

protected string GetObjectString(object theObject)

Parameters

theObject object

Returns

string

GetObjectType(XPClassInfo)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public XPObjectType GetObjectType(XPClassInfo objectType)

Parameters

objectType XPClassInfo

Returns

XPObjectType

GetObjectType(int)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public XPObjectType GetObjectType(int id)

Parameters

id int

Returns

XPObjectType

GetObjectType(object)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public XPObjectType GetObjectType(object theObject)

Parameters

theObject object

Returns

XPObjectType

GetObjects(XPClassInfo, CriteriaOperator, SortingCollection, int, bool, bool)

Gets a collection of persistent objects that match the specified criteria.

public ICollection GetObjects(XPClassInfo classInfo, CriteriaOperator criteria, SortingCollection sorting, int topSelectedRecords, bool selectDeleted, bool force)

Parameters

classInfo XPClassInfo

An XPClassInfo object that provides metadata information on the persistent objects to be returned.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the search criteria.

sorting SortingCollection

A SortingCollection object which represents a collection of DevExpress.Xpo.SortProperty objects.

topSelectedRecords int

An integer value which specifies the maximum number of returned objects.

selectDeleted bool

true to include the persistent objects marked as deleted into the collection; otherwise, false.

force bool

true to reload the objects from a data store; otherwise, false.

Returns

ICollection

A collection of persistent objects that match the specified criteria.

GetObjects(XPClassInfo, CriteriaOperator, SortingCollection, int, int, bool, bool)

Gets a collection of persistent objects that match the specified criteria.

public ICollection GetObjects(XPClassInfo classInfo, CriteriaOperator criteria, SortingCollection sorting, int skipSelectedRecords, int topSelectedRecords, bool selectDeleted, bool force)

Parameters

classInfo XPClassInfo

An XPClassInfo object that provides metadata information on the persistent objects to return.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the search criteria.

sorting SortingCollection

A SortingCollection object which represents a collection of DevExpress.Xpo.SortProperty objects.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the collection.

topSelectedRecords int

An integer value which specifies the maximum number of returned objects.

selectDeleted bool

true to include the persistent objects marked as deleted into the collection; otherwise, false.

force bool

true to reload the objects from a data store; otherwise, false.

Returns

ICollection

A collection of persistent objects that match the specified criteria.

GetObjects(ObjectsQuery[])

Gets a collection of persistent objects returned by specified queries.

public virtual ICollection[] GetObjects(ObjectsQuery[] queries)

Parameters

queries ObjectsQuery[]

An array of ObjectsQuery objects specifying queries that are executed to retrieve persistent objects.

Returns

ICollection[]

A collection of persistent objects returned by the queries.

GetObjectsAsync(XPClassInfo, CriteriaOperator, SortingCollection, int, bool, bool, AsyncLoadObjectsCallback)

Asynchronously gets a collection of persistent objects that match the specified criteria and notifies upon completion.

public object GetObjectsAsync(XPClassInfo classInfo, CriteriaOperator criteria, SortingCollection sorting, int topSelectedRecords, bool selectDeleted, bool force, AsyncLoadObjectsCallback callback)

Parameters

classInfo XPClassInfo

An XPClassInfo object that provides metadata information on the persistent objects to be returned.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the search criteria.

sorting SortingCollection

A SortingCollection object which represents a collection of DevExpress.Xpo.SortProperty objects.

topSelectedRecords int

An integer value which specifies the maximum number of returned objects.

selectDeleted bool

true to include the persistent objects marked as deleted into the collection; otherwise, false.

force bool

true to reload the objects from a data store; otherwise, false.

callback AsyncLoadObjectsCallback

A DevExpress.Xpo.Helpers.AsyncLoadObjectsCallback delegate to be called after the collection has been retrieved. This collection is passed as a parameter to callback.

Returns

object

An object identifying the current asynchronous operation, intended for internal use.

GetObjectsAsync(XPClassInfo, CriteriaOperator, SortingCollection, int, bool, bool, CancellationToken)

Asynchronously retrieves persistent objects, according to specific criteria, and notifies upon completion.

public Task<ICollection> GetObjectsAsync(XPClassInfo classInfo, CriteriaOperator criteria, SortingCollection sorting, int topSelectedRecords, bool selectDeleted, bool force, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that provides metadata information on the persistent objects to be returned.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the search criteria.

sorting SortingCollection

A SortingCollection object which represents a collection of DevExpress.Xpo.SortProperty objects.

topSelectedRecords int

An integer value which specifies the maximum number of returned objects.

selectDeleted bool

true, to include the persistent objects marked as deleted into the collection; otherwise, false.

force bool

true, to reload the objects from a data store; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task that returns a collection of obtained persistent objects.

GetObjectsAsync(XPClassInfo, CriteriaOperator, SortingCollection, int, int, bool, bool, AsyncLoadObjectsCallback)

Asynchronously gets a collection of persistent objects that match the specified criteria and notifies upon completion.

public object GetObjectsAsync(XPClassInfo classInfo, CriteriaOperator criteria, SortingCollection sorting, int skipSelectedRecords, int topSelectedRecords, bool selectDeleted, bool force, AsyncLoadObjectsCallback callback)

Parameters

classInfo XPClassInfo

An XPClassInfo object that provides metadata information on the persistent objects to be returned.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the search criteria.

sorting SortingCollection

A SortingCollection object which represents a collection of DevExpress.Xpo.SortProperty objects.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the collection.

topSelectedRecords int

An integer value which specifies the maximum number of returned objects.

selectDeleted bool

true to include the persistent objects marked as deleted into the collection; otherwise, false.

force bool

true to reload the objects from a data store; otherwise, false.

callback AsyncLoadObjectsCallback

A DevExpress.Xpo.Helpers.AsyncLoadObjectsCallback delegate to be called after the collection has been retrieved. This collection is passed as a parameter to callback.

Returns

object

An object identifying the current asynchronous operation, intended for internal use.

GetObjectsAsync(XPClassInfo, CriteriaOperator, SortingCollection, int, int, bool, bool, CancellationToken)

Asynchronously retrieves persistent objects from specified queries.

public Task<ICollection> GetObjectsAsync(XPClassInfo classInfo, CriteriaOperator criteria, SortingCollection sorting, int skipSelectedRecords, int topSelectedRecords, bool selectDeleted, bool force, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that provides metadata information on the persistent objects to be returned.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which represents the search criteria.

sorting SortingCollection

A SortingCollection object which represents a collection of DevExpress.Xpo.SortProperty objects.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the collection.

topSelectedRecords int

An integer value which specifies the maximum number of returned objects.

selectDeleted bool

true, to include the persistent objects marked as deleted into the collection; otherwise, false.

force bool

true, to reload the objects from a data store; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task that returns a collection of obtained persistent objects.

GetObjectsAsync(ObjectsQuery[], AsyncLoadObjectsCallback)

Asynchronously gets a collection of persistent objects that match the specified criteria and notifies upon completion.

public virtual object GetObjectsAsync(ObjectsQuery[] queries, AsyncLoadObjectsCallback callback)

Parameters

queries ObjectsQuery[]

The search queries.

callback AsyncLoadObjectsCallback

A DevExpress.Xpo.Helpers.AsyncLoadObjectsCallback delegate to be called after the collection has been retrieved. This collection is passed as a parameter to callback.

Returns

object

An object identifying the current asynchronous operation, intended for internal use.

GetObjectsAsync(ObjectsQuery[], CancellationToken)

Asynchronously retrieves persistent objects obtained from specified queries.

public virtual Task<ICollection[]> GetObjectsAsync(ObjectsQuery[] queries, CancellationToken cancellationToken = default)

Parameters

queries ObjectsQuery[]

An array of ObjectsQuery objects that specify queries executed to retrieve persistent objects.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection[]>

A Task that returns a collection of obtained persistent objects.

GetObjectsByKey(XPClassInfo, ICollection, bool)

Returns reloaded persistent objects with specified key property values from a data store.

public ICollection GetObjectsByKey(XPClassInfo classInfo, ICollection idCollection, bool alwaysGetFromDataStore)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the persistent class.

idCollection ICollection

A collection of objects representing the persistent object’s key property values.

alwaysGetFromDataStore bool

true to reload persistent objects from storage, if they are found in memory; otherwise, false.

Returns

ICollection

A collection of persistent objects with specified key property values.

GetObjectsByKey(ObjectsByKeyQuery[], bool)

Returns reloaded persistent objects from a data store, using queries based on specified object types and key values.

public ICollection[] GetObjectsByKey(ObjectsByKeyQuery[] queries, bool alwaysGetFromDataStore)

Parameters

queries ObjectsByKeyQuery[]

An array of ObjectsByKeyQuery objects, containing data for queries that retrieve persistent objects by specified object types and key values.

alwaysGetFromDataStore bool

true to reload persistent objects from storage if they are found in memory; otherwise, false.

Returns

ICollection[]

An array of persistent object collections retrieved for query data passed as the queries parameter.

GetObjectsByKeyAsync(XPClassInfo, ICollection, bool, CancellationToken)

Asynchronously returns reloaded persistent objects that have specified key property values from a data store.

public Task<ICollection> GetObjectsByKeyAsync(XPClassInfo classInfo, ICollection idCollection, bool alwaysGetFromDataStore, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that contains persistent class metadata.

idCollection ICollection

An object collection that represents a persistent object’s key property values.

alwaysGetFromDataStore bool

true, to always reload persistent objects from storage, even if they are found in memory; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task that returns an array of object collections. Objects in these collections match specified query parameters.

GetObjectsByKeyAsync(ObjectsByKeyQuery[], bool, CancellationToken)

Asynchronously returns reloaded persistent objects that have specified key property values from a data store.

public Task<ICollection[]> GetObjectsByKeyAsync(ObjectsByKeyQuery[] queries, bool alwaysGetFromDataStore, CancellationToken cancellationToken = default)

Parameters

queries ObjectsByKeyQuery[]

An array of ObjectsByKeyQuery objects that store persistent object information and key values. Queries use this data to retrieve specific persistent objects.

alwaysGetFromDataStore bool

true, to always reload persistent objects from storage, even if they are found in memory; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection[]>

A Task that returns an array of object collections.

GetObjectsByKeyFromQuery(XPClassInfo, bool, string)

Returns reloaded persistent objects from a data store, with key property values obtained via the specified SQL query.

public ICollection GetObjectsByKeyFromQuery(XPClassInfo classInfo, bool alwaysGetFromDataStore, string sql)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the persistent objects that are retrieved, based on the query’s result set.

alwaysGetFromDataStore bool

true to reload persistent objects from storage, if they are found in memory; otherwise, false.

sql string

A string value that specifies a SQL query.

Returns

ICollection

A collection of persistent objects with specified key property values.

GetObjectsByKeyFromSproc(XPClassInfo, bool, string, params OperandValue[])

Returns reloaded persistent objects from a data store, with key property values obtained via the specified stored procedure.

public ICollection GetObjectsByKeyFromSproc(XPClassInfo classInfo, bool alwaysGetFromDataStore, string sprocName, params OperandValue[] parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the persistent objects that are retrieved based on the stored procedure’s results.

alwaysGetFromDataStore bool

true to reload persistent objects from storage, if they are found in memory; otherwise, false.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of parameters to pass to the stored procedure.

Returns

ICollection

A collection of persistent objects with specified key property values.

GetObjectsByKeyFromSprocParametrized(XPClassInfo, bool, string, params SprocParameter[])

Returns persistent objects with the keys loaded with the specified stored procedure.

public ICollection GetObjectsByKeyFromSprocParametrized(XPClassInfo classInfo, bool alwaysGetFromDataStore, string sprocName, params SprocParameter[] parameters)

Parameters

classInfo XPClassInfo

The metadata information of the persistent objects that are retrieved based on the stored procedure results.

alwaysGetFromDataStore bool

true to always reload persistent objects from storage; otherwise, false.

sprocName string

The stored procedure name.

parameters SprocParameter[]

An array of parameters to pass to the stored procedure.

Returns

ICollection

A collection of persistent objects with specified key property values.

GetObjectsFromQuery(XPClassInfo, LoadDataMemberOrderItem[], string)

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, LoadDataMemberOrderItem[], string, QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql, QueryParameterCollection parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, LoadDataMemberOrderItem[], string, object[])

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql, object[] parameterValues)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, LoadDataMemberOrderItem[], string, string[], QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, LoadDataMemberOrderItem[], string, string[], object[])

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql, string[] parameterNames, object[] parameterValues)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

A list of XPMemberInfo objects representing classInfo members that are mapped to the query’s result set columns. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, List<XPMemberInfo>, string)

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, List<XPMemberInfo> members, string sql)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sql string

Specifies an SQL statement.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, List<XPMemberInfo>, string, QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, List<XPMemberInfo> members, string sql, QueryParameterCollection parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, List<XPMemberInfo>, string, object[])

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, List<XPMemberInfo> members, string sql, object[] parameterValues)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, List<XPMemberInfo>, string, string[], QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, List<XPMemberInfo> members, string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, List<XPMemberInfo>, string, string[], object[])

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, List<XPMemberInfo> members, string sql, string[] parameterNames, object[] parameterValues)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, string)

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, string sql)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, string, QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, string sql, QueryParameterCollection parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, string, object[])

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, string sql, object[] parameterValues)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, string, string[], QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQuery(XPClassInfo, string, string[], object[])

Executes a SQL query and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, string sql, string[] parameterNames, object[] parameterValues)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, LoadDataMemberOrderItem[], string, QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, LoadDataMemberOrderItem[], string, object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, LoadDataMemberOrderItem[], string, string[], QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql, string[] parameterNames, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, LoadDataMemberOrderItem[], string, string[], object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql, string[] parameterNames, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, LoadDataMemberOrderItem[], string, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, List<XPMemberInfo>, string, QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, List<XPMemberInfo> members, string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, List<XPMemberInfo>, string, object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, List<XPMemberInfo> members, string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, List<XPMemberInfo>, string, string[], QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, List<XPMemberInfo> members, string sql, string[] parameterNames, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, List<XPMemberInfo>, string, string[], object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, List<XPMemberInfo> members, string sql, string[] parameterNames, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, List<XPMemberInfo>, string, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, List<XPMemberInfo> members, string sql, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, string, QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, string, object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, string, string[], QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, string sql, string[] parameterNames, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, string, string[], object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, string sql, string[] parameterNames, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync(XPClassInfo, string, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromQueryAsync(XPClassInfo classInfo, string sql, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query’s result set. The class must be decorated with NonPersistentAttribute.

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[], string, QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[] members, string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[], string, object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[] members, string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[], string, string[], QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[] members, string sql, string[] parameterNames, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[], string, string[], object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[] members, string sql, string[] parameterNames, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[], string, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(LoadDataMemberOrderItem[] members, string sql, CancellationToken cancellationToken = default)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query’s result set columns.

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(List<XPMemberInfo>, string, QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(List<XPMemberInfo> members, string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(List<XPMemberInfo>, string, object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(List<XPMemberInfo> members, string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(List<XPMemberInfo>, string, string[], QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(List<XPMemberInfo> members, string sql, string[] parameterNames, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(List<XPMemberInfo>, string, string[], object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(List<XPMemberInfo> members, string sql, string[] parameterNames, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(List<XPMemberInfo>, string, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(List<XPMemberInfo> members, string sql, CancellationToken cancellationToken = default)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the result set. The order of list elements should correspond to the order of result set columns.

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(string, QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(string sql, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(string, object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(string sql, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(string, string[], QueryParameterCollection, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(string sql, string[] parameterNames, QueryParameterCollection parameters, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(string, string[], object[], CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(string sql, string[] parameterNames, object[] parameterValues, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQueryAsync<T>(string, CancellationToken)

Asynchronously executes a SQL query and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromQueryAsync<T>(string sql, CancellationToken cancellationToken = default)

Parameters

sql string

Specifies an SQL statement.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(LoadDataMemberOrderItem[], string)

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(LoadDataMemberOrderItem[] members, string sql)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for object members and the query’s result set columns.

sql string

Specifies an SQL statement.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(LoadDataMemberOrderItem[], string, QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(LoadDataMemberOrderItem[] members, string sql, QueryParameterCollection parameters)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for object members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(LoadDataMemberOrderItem[], string, object[])

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(LoadDataMemberOrderItem[] members, string sql, object[] parameterValues)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for object members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(LoadDataMemberOrderItem[], string, string[], QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(LoadDataMemberOrderItem[] members, string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for object members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(LoadDataMemberOrderItem[], string, string[], object[])

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(LoadDataMemberOrderItem[] members, string sql, string[] parameterNames, object[] parameterValues)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for object members and the query’s result set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(List<XPMemberInfo>, string)

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(List<XPMemberInfo> members, string sql)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sql string

Specifies an SQL statement.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(List<XPMemberInfo>, string, QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(List<XPMemberInfo> members, string sql, QueryParameterCollection parameters)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(List<XPMemberInfo>, string, object[])

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(List<XPMemberInfo> members, string sql, object[] parameterValues)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(List<XPMemberInfo>, string, string[], QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(List<XPMemberInfo> members, string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(List<XPMemberInfo>, string, string[], object[])

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(List<XPMemberInfo> members, string sql, string[] parameterNames, object[] parameterValues)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(string)

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(string sql)

Parameters

sql string

Specifies an SQL statement.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(string, QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(string sql, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(string, object[])

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(string sql, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(string, string[], QueryParameterCollection)

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(string sql, string[] parameterNames, QueryParameterCollection parameters)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameters QueryParameterCollection

Specifies query parameter values.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromQuery<T>(string, string[], object[])

Executes a SQL query and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromQuery<T>(string sql, string[] parameterNames, object[] parameterValues)

Parameters

sql string

Specifies an SQL statement.

parameterNames string[]

Specifies parameter names.

parameterValues object[]

An array of objects specifying parameters to pass to the database server along with the query.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSproc(XPClassInfo, LoadDataMemberOrderItem[], string, params OperandValue[])

Executes a stored procedure and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromSproc(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sprocName, params OperandValue[] parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the stored procedure’s result set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSproc(XPClassInfo, List<XPMemberInfo>, string, params OperandValue[])

Executes a stored procedure and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromSproc(XPClassInfo classInfo, List<XPMemberInfo> members, string sprocName, params OperandValue[] parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSproc(XPClassInfo, string, params OperandValue[])

Executes a stored procedure and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromSproc(XPClassInfo classInfo, string sprocName, params OperandValue[] parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocAsync(CancellationToken, XPClassInfo, LoadDataMemberOrderItem[], string, params OperandValue[])

Asynchronously executes a stored procedure and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromSprocAsync(CancellationToken cancellationToken, XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sprocName, params OperandValue[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the stored procedure’s result set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocAsync(CancellationToken, XPClassInfo, List<XPMemberInfo>, string, params OperandValue[])

Asynchronously executes a stored procedure and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromSprocAsync(CancellationToken cancellationToken, XPClassInfo classInfo, List<XPMemberInfo> members, string sprocName, params OperandValue[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocAsync(CancellationToken, XPClassInfo, string, params OperandValue[])

Asynchronously executes a stored procedure and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromSprocAsync(CancellationToken cancellationToken, XPClassInfo classInfo, string sprocName, params OperandValue[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocAsync<T>(CancellationToken, LoadDataMemberOrderItem[], string, params OperandValue[])

Asynchronously executes a stored procedure and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromSprocAsync<T>(CancellationToken cancellationToken, LoadDataMemberOrderItem[] members, string sprocName, params OperandValue[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the stored procedure’s result set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSprocAsync<T>(CancellationToken, List<XPMemberInfo>, string, params OperandValue[])

Asynchronously executes a stored procedure and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromSprocAsync<T>(CancellationToken cancellationToken, List<XPMemberInfo> members, string sprocName, params OperandValue[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSprocAsync<T>(CancellationToken, string, params OperandValue[])

Asynchronously executes a stored procedure and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromSprocAsync<T>(CancellationToken cancellationToken, string sprocName, params OperandValue[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSprocParametrized(XPClassInfo, LoadDataMemberOrderItem[], string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromSprocParametrized(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sprocName, params SprocParameter[] parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the stored procedure’s result set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocParametrized(XPClassInfo, List<XPMemberInfo>, string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromSprocParametrized(XPClassInfo classInfo, List<XPMemberInfo> members, string sprocName, params SprocParameter[] parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocParametrized(XPClassInfo, string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of non-persistent objects.

public ICollection GetObjectsFromSprocParametrized(XPClassInfo classInfo, string sprocName, params SprocParameter[] parameters)

Parameters

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocParametrizedAsync(CancellationToken, XPClassInfo, LoadDataMemberOrderItem[], string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromSprocParametrizedAsync(CancellationToken cancellationToken, XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sprocName, params SprocParameter[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the stored procedure’s result set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocParametrizedAsync(CancellationToken, XPClassInfo, List<XPMemberInfo>, string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromSprocParametrizedAsync(CancellationToken cancellationToken, XPClassInfo classInfo, List<XPMemberInfo> members, string sprocName, params SprocParameter[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocParametrizedAsync(CancellationToken, XPClassInfo, string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of non-persistent objects.

public Task<ICollection> GetObjectsFromSprocParametrizedAsync(CancellationToken cancellationToken, XPClassInfo classInfo, string sprocName, params SprocParameter[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

Task<ICollection>

A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

GetObjectsFromSprocParametrizedAsync<T>(CancellationToken, LoadDataMemberOrderItem[], string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromSprocParametrizedAsync<T>(CancellationToken cancellationToken, LoadDataMemberOrderItem[] members, string sprocName, params SprocParameter[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the stored procedure’s result set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSprocParametrizedAsync<T>(CancellationToken, List<XPMemberInfo>, string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromSprocParametrizedAsync<T>(CancellationToken cancellationToken, List<XPMemberInfo> members, string sprocName, params SprocParameter[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSprocParametrizedAsync<T>(CancellationToken, string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of non-persistent objects.

public Task<ICollection<T>> GetObjectsFromSprocParametrizedAsync<T>(CancellationToken cancellationToken, string sprocName, params SprocParameter[] parameters)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

Task<ICollection<T>>

A Task<TResult> that returns a collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSprocParametrized<T>(LoadDataMemberOrderItem[], string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromSprocParametrized<T>(LoadDataMemberOrderItem[] members, string sprocName, params SprocParameter[] parameters)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for object members and the stored procedure’s result set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSprocParametrized<T>(List<XPMemberInfo>, string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromSprocParametrized<T>(List<XPMemberInfo> members, string sprocName, params SprocParameter[] parameters)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSprocParametrized<T>(string, params SprocParameter[])

Executes a stored procedure with named parameters and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromSprocParametrized<T>(string sprocName, params SprocParameter[] parameters)

Parameters

sprocName string

A string value that specifies the stored procedure’s name.

parameters SprocParameter[]

An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSproc<T>(LoadDataMemberOrderItem[], string, params OperandValue[])

Executes a stored procedure and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromSproc<T>(LoadDataMemberOrderItem[] members, string sprocName, params OperandValue[] parameters)

Parameters

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for object members and the stored procedure’s result set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSproc<T>(List<XPMemberInfo>, string, params OperandValue[])

Executes a stored procedure and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromSproc<T>(List<XPMemberInfo> members, string sprocName, params OperandValue[] parameters)

Parameters

members List<XPMemberInfo>

Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting set columns.

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsFromSproc<T>(string, params OperandValue[])

Executes a stored procedure and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

public ICollection<T> GetObjectsFromSproc<T>(string sprocName, params OperandValue[] parameters)

Parameters

sprocName string

A string value that specifies the stored procedure’s name.

parameters OperandValue[]

An array of DevExpress.Data.Filtering.OperandValue objects representing parameters to pass to the stored procedure.

Returns

ICollection<T>

A collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Type Parameters

T

The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

GetObjectsInTransaction(XPClassInfo, CriteriaOperator, SortingCollection, int, int, bool)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public ICollection GetObjectsInTransaction(XPClassInfo classInfo, CriteriaOperator condition, SortingCollection sorting, int skipSelectedRecords, int topSelectedRecords, bool selectDeleted)

Parameters

classInfo XPClassInfo

condition CriteriaOperator

sorting SortingCollection

skipSelectedRecords int

topSelectedRecords int

selectDeleted bool

Returns

ICollection

GetObjectsInTransaction(XPClassInfo, CriteriaOperator, bool)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public ICollection GetObjectsInTransaction(XPClassInfo classInfo, CriteriaOperator condition, bool selectDeleted)

Parameters

classInfo XPClassInfo

condition CriteriaOperator

selectDeleted bool

Returns

ICollection

GetObjectsInTransactionAsync(XPClassInfo, CriteriaOperator, SortingCollection, int, int, bool, AsyncLoadObjectsCallback)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public object GetObjectsInTransactionAsync(XPClassInfo classInfo, CriteriaOperator condition, SortingCollection sorting, int skipSelectedRecords, int topSelectedRecords, bool selectDeleted, AsyncLoadObjectsCallback callback)

Parameters

classInfo XPClassInfo

condition CriteriaOperator

sorting SortingCollection

skipSelectedRecords int

topSelectedRecords int

selectDeleted bool

callback AsyncLoadObjectsCallback

Returns

object

GetObjectsInTransactionAsync(XPClassInfo, CriteriaOperator, SortingCollection, int, int, bool, CancellationToken)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public Task<ICollection> GetObjectsInTransactionAsync(XPClassInfo classInfo, CriteriaOperator condition, SortingCollection sorting, int skipSelectedRecords, int topSelectedRecords, bool selectDeleted, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

condition CriteriaOperator

sorting SortingCollection

skipSelectedRecords int

topSelectedRecords int

selectDeleted bool

cancellationToken CancellationToken

Returns

Task<ICollection>

GetObjectsInTransactionAsync(XPClassInfo, CriteriaOperator, bool, AsyncLoadObjectsCallback)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public object GetObjectsInTransactionAsync(XPClassInfo classInfo, CriteriaOperator condition, bool selectDeleted, AsyncLoadObjectsCallback callback)

Parameters

classInfo XPClassInfo

condition CriteriaOperator

selectDeleted bool

callback AsyncLoadObjectsCallback

Returns

object

GetObjectsInTransactionAsync(XPClassInfo, CriteriaOperator, bool, CancellationToken)

This member supports the internal infrastructure and is not intended to be used directly from your code.

public Task<ICollection> GetObjectsInTransactionAsync(XPClassInfo classInfo, CriteriaOperator condition, bool selectDeleted, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

condition CriteriaOperator

selectDeleted bool

cancellationToken CancellationToken

Returns

Task<ICollection>

GetObjectsToDelete()

Returns a collection of persistent objects that will be deleted when the current transaction is committed.

public ICollection GetObjectsToDelete()

Returns

ICollection

The collection of persistent objects that when the current transaction is committed.

GetObjectsToDelete(bool)

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.

public virtual ICollection GetObjectsToDelete(bool includeParent)

Parameters

includeParent bool

true, to include persistent objects that will be deleted in the parent transaction(s); otherwise, false.

Returns

ICollection

The collection of persistent objects that will be deleted when the current transaction is committed.

GetObjectsToSave()

Returns a collection of objects that will be saved when the current transaction is committed.

public ICollection GetObjectsToSave()

Returns

ICollection

The collection of persistent objects that will be saved when the current transaction is committed.

GetObjectsToSave(bool)

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.

public virtual ICollection GetObjectsToSave(bool includeParent)

Parameters

includeParent bool

true, to include persistent objects that will be saved in the parent transaction(s); otherwise, false.

Returns

ICollection

The collection of persistent objects that will be saved when the current transaction is committed.

GetProperties(XPClassInfo)

Gets the properties of the class whose metadata is provided by the specified XPClassInfo object.

public PropertyDescriptorCollection GetProperties(XPClassInfo classInfo)

Parameters

classInfo XPClassInfo

An XPClassInfo object which provides class description.

Returns

PropertyDescriptorCollection

A collection of PropertyDescriptor objects.

GetPropertiesListForUpdateInsert(object, bool, bool)

protected virtual MemberInfoCollection GetPropertiesListForUpdateInsert(object theObject, bool isUpdate, bool addDelayedReference)

Parameters

theObject object

isUpdate bool

addDelayedReference bool

Returns

MemberInfoCollection

GetTouchedClassInfosIncludeParent()

protected virtual ICollection GetTouchedClassInfosIncludeParent()

Returns

ICollection

IsNewObject(object)

Indicates whether the specified object is contained within the session’s cache.

public bool IsNewObject(object theObject)

Parameters

theObject object

An object which represents the persistent object.

Returns

bool

true if the specified object doesn’t contain within the session’s cache; otherwise, false.

IsObjectMarkedDeleted(object)

Indicates whether the specified persistent object is marked as deleted.

public bool IsObjectMarkedDeleted(object theObject)

Parameters

theObject object

The object to test.

Returns

bool

true if the specified object is marked as deleted; otherwise, false.

IsObjectToDelete(object)

Indicates whether the specified object is deleted in the transaction currently in progress.

public bool IsObjectToDelete(object theObject)

Parameters

theObject object

The persistent object to test.

Returns

bool

true if the specified object is deleted in the transaction currently in progress; otherwise, false.

IsObjectToDelete(object, bool)

Indicates whether the specified object is deleted in the transaction currently in progress or in any of its parent transaction (optionally).

public virtual bool IsObjectToDelete(object theObject, bool includeParent)

Parameters

theObject object

The persistent object to test.

includeParent bool

true to check whether the persistent object is deleted in the parent transaction(s); otherwise, false.

Returns

bool

true if the specified object is deleted in the transaction currently in progress or in any of its parent transaction (optionally); otherwise, false.

IsObjectToSave(object)

Indicates whether the specified object is saved in the transaction currently in progress.

public bool IsObjectToSave(object theObject)

Parameters

theObject object

The persistent object to test.

Returns

bool

true if the specified object is saved in the transaction currently in progress; otherwise, false.

IsObjectToSave(object, bool)

Indicates whether the specified object is saved in the transaction currently in progress or in any of its parent transaction (optionally).

public virtual bool IsObjectToSave(object theObject, bool includeParent)

Parameters

theObject object

The persistent object to test.

includeParent bool

true to check whether the persistent object is saved in the parent transaction(s); otherwise, false.

Returns

bool

true if the specified object is saved in the transaction currently in progress or in any of its parent transaction (optionally); otherwise, false.

LoadDelayedProperties(IList, XPMemberInfo)

protected virtual ObjectDictionary<object> LoadDelayedProperties(IList objects, XPMemberInfo property)

Parameters

objects IList

property XPMemberInfo

Returns

ObjectDictionary<object>

LoadDelayedProperties(object, MemberPathCollection)

protected virtual object[] LoadDelayedProperties(object theObject, MemberPathCollection props)

Parameters

theObject object

props MemberPathCollection

Returns

object[]

LoadDelayedPropertiesAsync(IList, XPMemberInfo, CancellationToken)

protected virtual Task<ObjectDictionary<object>> LoadDelayedPropertiesAsync(IList objects, XPMemberInfo property, CancellationToken cancellationToken = default)

Parameters

objects IList

property XPMemberInfo

cancellationToken CancellationToken

Returns

Task<ObjectDictionary<object>>

OnAfterBeginTrackingChanges()

protected virtual void OnAfterBeginTrackingChanges()

OnAfterBeginTrackingChangesInternal()

protected void OnAfterBeginTrackingChangesInternal()

OnAfterBeginTransaction()

protected virtual void OnAfterBeginTransaction()

OnAfterCommitNestedUnitOfWork(SessionManipulationEventArgs)

protected virtual void OnAfterCommitNestedUnitOfWork(SessionManipulationEventArgs e)

Parameters

e SessionManipulationEventArgs

OnAfterCommitTransaction()

protected virtual void OnAfterCommitTransaction()

OnAfterConnect()

protected virtual void OnAfterConnect()

OnAfterDisconnect()

protected virtual void OnAfterDisconnect()

OnAfterDropChanges()

protected virtual void OnAfterDropChanges()

OnAfterDropChangesInternal()

protected void OnAfterDropChangesInternal()

OnAfterDropIdentityMap()

protected void OnAfterDropIdentityMap()

OnAfterFlushChanges()

protected virtual void OnAfterFlushChanges()

OnAfterFlushChangesInternal()

protected void OnAfterFlushChangesInternal()

OnAfterRollbackTransaction()

protected virtual void OnAfterRollbackTransaction()

OnBeforeBeginTrackingChanges()

protected virtual void OnBeforeBeginTrackingChanges()

OnBeforeBeginTrackingChangesInternal()

protected void OnBeforeBeginTrackingChangesInternal()

OnBeforeBeginTransaction()

protected virtual void OnBeforeBeginTransaction()

OnBeforeCommitNestedUnitOfWork(SessionManipulationEventArgs)

protected virtual void OnBeforeCommitNestedUnitOfWork(SessionManipulationEventArgs e)

Parameters

e SessionManipulationEventArgs

OnBeforeCommitTransaction()

protected virtual void OnBeforeCommitTransaction()

OnBeforeConnect()

protected virtual void OnBeforeConnect()

OnBeforeDisconnect()

protected virtual void OnBeforeDisconnect()

OnBeforeDropChanges()

protected virtual void OnBeforeDropChanges()

OnBeforeDropChangesInternal()

protected void OnBeforeDropChangesInternal()

OnBeforeFlushChanges()

protected virtual void OnBeforeFlushChanges()

OnBeforeFlushChangesInternal()

protected void OnBeforeFlushChangesInternal()

OnBeforeRollbackTransaction()

protected virtual void OnBeforeRollbackTransaction()

OnFailedCommitTransaction(Exception)

protected virtual bool OnFailedCommitTransaction(Exception ex)

Parameters

ex Exception

Returns

bool

OnFailedFlushChanges(Exception)

protected virtual bool OnFailedFlushChanges(Exception ex)

Parameters

ex Exception

Returns

bool

OnFailedFlushChangesInternal(Exception)

protected bool OnFailedFlushChangesInternal(Exception ex)

Parameters

ex Exception

Returns

bool

OnObjectChanged(object, ObjectChangeEventArgs)

protected virtual void OnObjectChanged(object changedObject, ObjectChangeEventArgs e)

Parameters

changedObject object

e ObjectChangeEventArgs

OnObjectDeleted(ObjectManipulationEventArgs)

protected virtual void OnObjectDeleted(ObjectManipulationEventArgs e)

Parameters

e ObjectManipulationEventArgs

OnObjectDeleting(ObjectManipulationEventArgs)

protected virtual void OnObjectDeleting(ObjectManipulationEventArgs e)

Parameters

e ObjectManipulationEventArgs

OnObjectLoaded(ObjectManipulationEventArgs)

protected virtual void OnObjectLoaded(ObjectManipulationEventArgs e)

Parameters

e ObjectManipulationEventArgs

OnObjectLoading(ObjectManipulationEventArgs)

protected virtual void OnObjectLoading(ObjectManipulationEventArgs e)

Parameters

e ObjectManipulationEventArgs

OnObjectSaved(ObjectManipulationEventArgs)

protected virtual void OnObjectSaved(ObjectManipulationEventArgs e)

Parameters

e ObjectManipulationEventArgs

OnObjectSaving(ObjectManipulationEventArgs)

protected virtual void OnObjectSaving(ObjectManipulationEventArgs e)

Parameters

e ObjectManipulationEventArgs

OnObjectsLoaded(ObjectsManipulationEventArgs)

protected virtual void OnObjectsLoaded(ObjectsManipulationEventArgs e)

Parameters

e ObjectsManipulationEventArgs

OnObjectsSaved(ObjectsManipulationEventArgs)

protected virtual void OnObjectsSaved(ObjectsManipulationEventArgs e)

Parameters

e ObjectsManipulationEventArgs

PreFetch(XPClassInfo, IEnumerable, params string[])

Enforces loading data for associated collections and delayed properties.

public void PreFetch(XPClassInfo classInfo, IEnumerable objects, params string[] propertyPaths)

Parameters

classInfo XPClassInfo

An XPClassInfo object that provides metadata information for a parent class.

objects IEnumerable

An IEnumerable list of parent objects.

propertyPaths string[]

An array of strings that are the collection property and delayed property names, or property paths (e.g, “ChildCollection.AnotherChildCollection”).

PreFetch(IEnumerable, XPMemberInfo, IEnumerable)

Enforces loading data for an associated collection.

public void PreFetch(IEnumerable objects, XPMemberInfo collectionInObjects, IEnumerable collectionsContent)

Parameters

objects IEnumerable

An IEnumerable list of parent objects.

collectionInObjects XPMemberInfo

An XPMemberInfo object that provides metadata information for an associated collection.

collectionsContent IEnumerable

An IEnumerable list of the collection’s content. If the collectionInObjects data was previously loaded, you can avoid reloading it by passing the loaded data to the collectionsContent parameter. Note that if this parameter does not contain a part of the collection’s content, this part will not be loaded from a database.

PreFetchAsync(XPClassInfo, IEnumerable, CancellationToken, params string[])

Asynchronously forces associated collection data loading and delayed property loading for specified parent objects.

public Task PreFetchAsync(XPClassInfo classInfo, IEnumerable objects, CancellationToken cancellationToken, params string[] propertyPaths)

Parameters

classInfo XPClassInfo

An XPClassInfo object that contains metadata information. This data specifies the parent object that needs associated collection data loading and delayed property loading.

objects IEnumerable

An IEnumerable list of parent objects.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

propertyPaths string[]

An array of strings that are the collection property and delayed property names, or property paths (e.g, “ChildCollection.AnotherChildCollection”).

Returns

Task

A Task that forces associated collection data loading and delayed property loading for specified parent objects.

PreFetchAsync(IEnumerable, XPMemberInfo, IEnumerable, CancellationToken)

Asynchronously forces associated collection data loading for specified parent objects.

public Task PreFetchAsync(IEnumerable objects, XPMemberInfo collectionInObjects, IEnumerable collectionsContent, CancellationToken cancellationToken = default)

Parameters

objects IEnumerable

An IEnumerable list of parent objects.

collectionInObjects XPMemberInfo

An XPMemberInfo object that contains metadata information. This data specifies associated collection data to be retrieved.

collectionsContent IEnumerable

An IEnumerable list of the collection’s content. If the collectionInObjects data was previously loaded, you can avoid reloading it by passing the loaded data to the collectionsContent parameter. Note that if this parameter does not contain a part of the collection’s content, this part will not be loaded from a database.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that forces associated collection data loading for specified parent objects.

PreFetchAsync<T>(IEnumerable<T>, string, IEnumerable, CancellationToken)

Asynchronously forces associated collection data loading for specified parent objects.

public Task PreFetchAsync<T>(IEnumerable<T> objects, string collectionInObjects, IEnumerable collectionsContent, CancellationToken cancellationToken)

Parameters

objects IEnumerable<T>

An IEnumerable list of parent objects.

collectionInObjects string

A string which is the name of the associated collection property.

collectionsContent IEnumerable

An IEnumerable list of the collection’s content. If the collectionInObjects data was previously loaded, you can avoid reloading it by passing the loaded data to the collectionsContent parameter. Note that if this parameter does not contain a part of the collection’s content, this part will not be loaded from a database.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that forces associated collection data loading for specified parent objects.

Type Parameters

T

The type of elements in the list of parent objects.

PreFetchAsync<T>(IEnumerable<T>, CancellationToken, params string[])

Asynchronously forces associated collection data loading and delayed property loading for specified parent objects.

public Task PreFetchAsync<T>(IEnumerable<T> objects, CancellationToken cancellationToken, params string[] propertyPaths)

Parameters

objects IEnumerable<T>

An IEnumerable list of parent objects.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

propertyPaths string[]

An array of strings that are the collection property and delayed property names, or property paths (e.g, “ChildCollection.AnotherChildCollection”).

Returns

Task

A Task that forces associated collection data loading and delayed property loading for specified parent objects.

Type Parameters

T

The type of elements in the list of parent objects.

PreFetch<T>(IEnumerable<T>, string, IEnumerable)

Enforces loading data for associated collections.

public void PreFetch<T>(IEnumerable<T> objects, string collectionInObjects, IEnumerable collectionsContent)

Parameters

objects IEnumerable<T>

An IEnumerable list of parent objects.

collectionInObjects string

A string which is the name of the associated collection property.

collectionsContent IEnumerable

An IEnumerable list of the collection’s content. If the collectionInObjects data was previously loaded, you can avoid reloading it by passing the loaded data to the collectionsContent parameter. Note that if this parameter does not contain a part of the collection’s content, this part will not be loaded from a database.

Type Parameters

T

The type of elements in the list of parent objects.

PreFetch<T>(IEnumerable<T>, params string[])

Enforces loading data for associated collections and delayed properties.

public void PreFetch<T>(IEnumerable<T> objects, params string[] propertyPaths) where T : class

Parameters

objects IEnumerable<T>

An IEnumerable list of parent objects.

propertyPaths string[]

An array of strings that are the collection property and delayed property names, or property paths (e.g, “ChildCollection.AnotherChildCollection”).

Type Parameters

T

The type of elements in the list of parent objects.

ProcessReferences(object, ProcessReferenceHandler)

Returns a list objects that were processed within the specified event handler.

public IList ProcessReferences(object target, ProcessReferenceHandler process)

Parameters

target object

process ProcessReferenceHandler

Returns

IList

PurgeDeletedObjects()

Deletes the objects marked as deleted from storage.

public PurgeResult PurgeDeletedObjects()

Returns

PurgeResult

A PurgeResult object containing removal statistics (the number of objects processed, purged, etc.)

PurgeDeletedObjects(IObjectLayer)

Deletes the objects marked as deleted from a storage.

public static PurgeResult PurgeDeletedObjects(IObjectLayer objectLayer)

Parameters

objectLayer IObjectLayer

An object which implements the IObjectLayer interface.

Returns

PurgeResult

A PurgeResult value that specifies the result of the operation.

Reload(object)

Reloads the state of the specified persistent object from the data store.

public void Reload(object theObject)

Parameters

theObject object

An object which represents the persistent object whose state needs to be reloaded.

Reload(object, bool)

Reloads the state of the specified persistent object and its aggregated objects from the data store, recursively.

public void Reload(object theObject, bool forceAggregatesReload)

Parameters

theObject object

An object which represents the persistent object whose state needs to be reloaded.

forceAggregatesReload bool

true, to recursively reload the state of aggregated objects; otherwise, false.

ReloadAsync(object, bool, CancellationToken)

Recursively reloads a persistent object’s state and aggregated objects from the data store, asynchronously.

public Task ReloadAsync(object theObject, bool forceAggregatesReload, CancellationToken cancellationToken = default)

Parameters

theObject object

An object which represents the persistent object whose state needs to be reloaded.

forceAggregatesReload bool

true, to recursively reload the state of aggregated objects; otherwise, false.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that reloads a persistent object’s state and aggregated objects from the data store.

ReloadAsync(object, CancellationToken)

Recursively reloads a persistent object’s state and aggregated objects from the data store, asynchronously.

public Task ReloadAsync(object theObject, CancellationToken cancellationToken = default)

Parameters

theObject object

An object which represents the persistent object whose state needs to be reloaded.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that reloads a persistent object’s state and aggregated objects from the data store.

RollbackTransaction()

Rolls back a transaction to its starting point, and completes it.

public virtual void RollbackTransaction()

Save(ICollection)

Saves the specified persistent objects to a data store.

public void Save(ICollection objects)

Parameters

objects ICollection

A collection of persistent objects to save in a data store.

Save(object)

Saves the specified persistent object to a data store.

public void Save(object theObject)

Parameters

theObject object

An object which represents the persistent object to save.

SaveAsync(object, CancellationToken)

Asynchronously saves the specified persistent object to a data store.

public Task SaveAsync(object theObject, CancellationToken cancellationToken = default)

Parameters

theObject object

An object which represents the persistent object to save.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that saves the specified persistent object to a data store.

SelectData(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, CriteriaOperatorCollection, CriteriaOperator, bool, int, SortingCollection)

Retrieves objects from a session using the specified query parameters.

public List<object[]> SelectData(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, CriteriaOperatorCollection groupProperties, CriteriaOperator groupCriteria, bool selectDeleted, int topSelectedRecords, SortingCollection sorting)

Parameters

classInfo XPClassInfo

An XPClassInfo object which provides the metadata information for the objects to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

groupProperties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies the grouping properties.

groupCriteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the grouping criteria for the retrieved objects.

selectDeleted bool

A Boolean value that specifies whether the objects marked as deleted must be retrieved.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

Returns

List<object[]>

A list whose elements are property values that correspond to the properties of objects retrieved from the session.

SelectData(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, CriteriaOperatorCollection, CriteriaOperator, bool, int, int, SortingCollection)

Retrieves objects from a session using the specified query parameters.

public List<object[]> SelectData(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, CriteriaOperatorCollection groupProperties, CriteriaOperator groupCriteria, bool selectDeleted, int skipSelectedRecords, int topSelectedRecords, SortingCollection sorting)

Parameters

classInfo XPClassInfo

An XPClassInfo object which provides the metadata information for the objects to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

groupProperties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies the grouping properties.

groupCriteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the grouping criteria for the retrieved objects.

selectDeleted bool

true to include the persistent objects marked as deleted into the list; otherwise, false.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the list.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

Returns

List<object[]>

A list whose elements are property values that correspond to the properties of objects retrieved from the session.

SelectData(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, bool, int, SortingCollection)

Retrieves objects from a session using the specified query parameters.

public List<object[]> SelectData(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, bool selectDeleted, int topSelectedRecords, SortingCollection sorting)

Parameters

classInfo XPClassInfo

An XPClassInfo object which provides the metadata information for the objects to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

selectDeleted bool

A Boolean value that specifies whether the objects marked as deleted must be retrieved.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

Returns

List<object[]>

A list whose elements are property values that correspond to the properties of objects retrieved from the session.

SelectData(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, bool, int, int, SortingCollection)

Retrieves objects from a session using the specified query parameters.

public List<object[]> SelectData(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, bool selectDeleted, int skipSelectedRecords, int topSelectedRecords, SortingCollection sorting)

Parameters

classInfo XPClassInfo

An XPClassInfo object which provides the metadata information for the objects to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

selectDeleted bool

true to include the persistent objects marked as deleted into the list; otherwise, false.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the list.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of retrieved objects.

Returns

List<object[]>

A list whose elements are property values that correspond to the properties of objects retrieved from the session.

SelectDataAsync(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, CriteriaOperatorCollection, CriteriaOperator, bool, int, SortingCollection, CancellationToken)

Retrieves object data from a session asynchronously, according to specified query parameters.

public Task<List<object[]>> SelectDataAsync(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, CriteriaOperatorCollection groupProperties, CriteriaOperator groupCriteria, bool selectDeleted, int topSelectedRecords, SortingCollection sorting, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that contains metadata information. This data specifies which objects need to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

groupProperties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies the grouping properties.

groupCriteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the grouping criteria for the retrieved objects.

selectDeleted bool

A Boolean value that specifies whether the objects marked as deleted must be retrieved.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<List<object[]>>

A Task that returns a list of object arrays. These object arrays represent object properties retrieved from a data store.

SelectDataAsync(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, CriteriaOperatorCollection, CriteriaOperator, bool, int, int, SortingCollection, AsyncSelectDataCallback)

Asynchronously retrieves objects from a session, using the specified query parameters.

public object SelectDataAsync(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, CriteriaOperatorCollection groupProperties, CriteriaOperator groupCriteria, bool selectDeleted, int skipSelectedRecords, int topSelectedRecords, SortingCollection sorting, AsyncSelectDataCallback callback)

Parameters

classInfo XPClassInfo

An XPClassInfo object which provides the metadata information for the objects to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

groupProperties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies the grouping properties.

groupCriteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the grouping criteria for the retrieved objects.

selectDeleted bool

true to include the persistent objects marked as deleted into the list; otherwise, false.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the list.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of retrieved objects.

callback AsyncSelectDataCallback

A AsyncSelectDataCallback delegate to be called after the list has been retrieved. This list is passed as a parameter to callback.

Returns

object

An object identifying the current asynchronous operation, intended for internal use.

SelectDataAsync(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, CriteriaOperatorCollection, CriteriaOperator, bool, int, int, SortingCollection, CancellationToken)

Retrieves object data from a session asynchronously, according to specified query parameters.

public Task<List<object[]>> SelectDataAsync(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, CriteriaOperatorCollection groupProperties, CriteriaOperator groupCriteria, bool selectDeleted, int skipSelectedRecords, int topSelectedRecords, SortingCollection sorting, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that contains metadata information. This data specifies which objects need to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

groupProperties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies the grouping properties.

groupCriteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the grouping criteria for the retrieved objects.

selectDeleted bool

A Boolean value that specifies whether the objects marked as deleted must be retrieved.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the list.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<List<object[]>>

A Task that returns a list of object arrays. These object arrays represent object properties retrieved from a data store.

SelectDataAsync(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, bool, int, SortingCollection, CancellationToken)

Retrieves object data from a session asynchronously according to specified query parameters.

public Task<List<object[]>> SelectDataAsync(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, bool selectDeleted, int topSelectedRecords, SortingCollection sorting, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that contains metadata information. This data specifies which objects need to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

selectDeleted bool

A Boolean value that specifies whether the objects marked as deleted must be retrieved.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<List<object[]>>

A Task that returns a list of object arrays. These object arrays represent object properties retrieved from a data store.

SelectDataAsync(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, bool, int, int, SortingCollection, CancellationToken)

Retrieves object data from a session asynchronously, according to specified query parameters.

public Task<List<object[]>> SelectDataAsync(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, bool selectDeleted, int skipSelectedRecords, int topSelectedRecords, SortingCollection sorting, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that contains metadata information. This data specifies which objects need to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

selectDeleted bool

true, to include the persistent objects marked as deleted into the list; otherwise, false.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the list.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of retrieved objects.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<List<object[]>>

A Task that returns a list of object arrays. These object arrays represent object properties retrieved from a data store.

SelectDataInTransaction(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, CriteriaOperatorCollection, CriteriaOperator, bool, int, int, SortingCollection)

Retrieves objects from a session using the specified query parameters, including all in-memory changes into query results.

public List<object[]> SelectDataInTransaction(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, CriteriaOperatorCollection groupProperties, CriteriaOperator groupCriteria, bool selectDeleted, int skipSelectedRecords, int topSelectedRecords, SortingCollection sorting)

Parameters

classInfo XPClassInfo

An XPClassInfo object which provides the metadata information for the objects to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

groupProperties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies the grouping properties.

groupCriteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the grouping criteria for the retrieved objects.

selectDeleted bool

A Boolean value that specifies whether the objects marked as deleted must be retrieved.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the list.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

Returns

List<object[]>

A list whose elements are property values that correspond to the properties of objects retrieved from the session.

SelectDataInTransactionAsync(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, CriteriaOperatorCollection, CriteriaOperator, bool, int, int, SortingCollection, CancellationToken)

Asynchronously retrieves objects from a session, according to specified query parameters. Accounts for all in-memory object changes.

public Task<List<object[]>> SelectDataInTransactionAsync(XPClassInfo classInfo, CriteriaOperatorCollection properties, CriteriaOperator criteria, CriteriaOperatorCollection groupProperties, CriteriaOperator groupCriteria, bool selectDeleted, int skipSelectedRecords, int topSelectedRecords, SortingCollection sorting, CancellationToken cancellationToken = default)

Parameters

classInfo XPClassInfo

An XPClassInfo object that contains metadata information. This data specifies which objects need to be retrieved.

properties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the objects to be retrieved.

groupProperties CriteriaOperatorCollection

A DevExpress.Data.Filtering.CriteriaOperatorCollection object which specifies the grouping properties.

groupCriteria CriteriaOperator

A DevExpress.Data.Filtering.CriteriaOperator descendant which specifies the grouping criteria for the retrieved objects.

selectDeleted bool

A Boolean value that specifies whether the objects marked as deleted must be retrieved.

skipSelectedRecords int

An integer value which specifies the number of objects to exclude when populating the list.

topSelectedRecords int

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task<List<object[]>>

A Task that returns a list of object arrays. These object arrays represent object properties retrieved from a session.

SetAsyncRequestPriority(object, AsyncRequestPriority)

This method is intended for internal use.

public static void SetAsyncRequestPriority(object asyncResult, AsyncRequestPriority priority)

Parameters

asyncResult object

priority AsyncRequestPriority

SetKeyValue(object, object)

Assigns the key property’s value of the specified persistent object.

public void SetKeyValue(object theObject, object keyValue)

Parameters

theObject object

A persistent object whose key property value is set.

keyValue object

An object representing the key property’s value.

ToString()

Returns a string that represents the current session.

public override string ToString()

Returns

string

A string value which represents the current object.

UpdateSchema()

Updates the storage schema according to the class descriptions that are listed in the assemblies that have been loaded into the application domain.

public void UpdateSchema()

UpdateSchema(params XPClassInfo[])

Updates the database schema to support the persistence of the objects with the specified metadata information.

public void UpdateSchema(params XPClassInfo[] types)

Parameters

types XPClassInfo[]

An array of XPClassInfo objects that specify object metadata for which schema should be created in the data store.

UpdateSchema(bool, params XPClassInfo[])

Updates a data store’s schema according to the class descriptions of the specified types.

public UpdateSchemaResult UpdateSchema(bool doNotCreateIfFirstTableNotExist, params XPClassInfo[] types)

Parameters

doNotCreateIfFirstTableNotExist bool

true if the schema should not be created when the table that corresponds to the first item in the types array doesn’t exist in the data store; otherwise, false.

types XPClassInfo[]

An array of XPClassInfo objects that specify the types of objects for which schema should be created in the data store.

Returns

UpdateSchemaResult

An DevExpress.Xpo.DB.UpdateSchemaResult enumeration value which specifies the result of the update operation.

UpdateSchema(params Assembly[])

Updates the storage schema according to the class descriptions that are listed in the specified assemblies.

public void UpdateSchema(params Assembly[] assemblies)

Parameters

assemblies Assembly[]

An array of Assembly objects that represent the assemblies used to scan for persistent objects.

UpdateSchema(params Type[])

Updates a data store’s schema according to the class descriptions of the specified types.

public void UpdateSchema(params Type[] types)

Parameters

types Type[]

An array of Type objects that represent the types of objects for which schema should be created in the data store.

UpdateSchemaAsync(CancellationToken)

Asynchronously updates the storage schema according to the class descriptions that are listed in the assemblies that have been loaded into the application domain.

public Task UpdateSchemaAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Task

A Task that updates the storage schema according to the class descriptions that are listed in the assemblies that have been loaded into the application domain.

UpdateSchemaAsync(CancellationToken, params XPClassInfo[])

Asynchronously updates the database schema to support the persistence of the objects with the specified metadata information.

public Task UpdateSchemaAsync(CancellationToken cancellationToken, params XPClassInfo[] types)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

types XPClassInfo[]

An array of XPClassInfo objects that specify the types of objects for which schema should be created in the data store.

Returns

Task

A Task that updates the database schema to support the persistence of the objects with the specified metadata information.

UpdateSchemaAsync(CancellationToken, bool, params XPClassInfo[])

Asynchronously updates the database schema to support the persistence of the objects with the specified metadata information.

public Task<UpdateSchemaResult> UpdateSchemaAsync(CancellationToken cancellationToken, bool doNotCreateIfFirstTableNotExist, params XPClassInfo[] types)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

doNotCreateIfFirstTableNotExist bool

true if the schema should not be created when the table that corresponds to the first item in the types array doesn’t exist in the data store; otherwise, false.

types XPClassInfo[]

An array of XPClassInfo objects that specify the types of objects for which schema should be created in the data store.

Returns

Task<UpdateSchemaResult>

A Task<TResult> that returns an DevExpress.Xpo.DB.UpdateSchemaResult enumeration value which specifies the result of the update operation.

UpdateSchemaAsync(CancellationToken, params Assembly[])

Asynchronously updates the storage schema according to the class descriptions that are listed in the specified assemblies.

public Task UpdateSchemaAsync(CancellationToken cancellationToken, params Assembly[] assemblies)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

assemblies Assembly[]

An array of Assembly objects that represent the assemblies used to scan for persistent objects.

Returns

Task

A Task that updates the storage schema according to the class descriptions that are listed in the specified assemblies.

UpdateSchemaAsync(CancellationToken, params Type[])

Asynchronously updates a data store’s schema according to the class descriptions of the specified types.

public Task UpdateSchemaAsync(CancellationToken cancellationToken, params Type[] types)

Parameters

cancellationToken CancellationToken

A CancellationToken object that delivers a cancellation notice to the running operation.

types Type[]

An array of Type objects that represent the types of objects for which schema should be created in the data store.

Returns

Task

A Task that updates a data store’s schema according to the class descriptions of the specified types.

WaitForAsyncRequestComplete(Session, object)

This method is intended for internal use.

public static WaitForAsyncOperationResult WaitForAsyncRequestComplete(Session session, object asyncResult)

Parameters

session Session

asyncResult object

Returns

WaitForAsyncOperationResult

Events

AfterBeginTrackingChanges

Occurs after a transaction (a database level transaction in an explicit unit of work) has been started tracking changes made to persistent objects.

public event SessionManipulationEventHandler AfterBeginTrackingChanges

Event Type

SessionManipulationEventHandler

AfterBeginTransaction

Occurs after a transaction has been started via the BEGIN operation.

public event SessionManipulationEventHandler AfterBeginTransaction

Event Type

SessionManipulationEventHandler

AfterCommitTransaction

Occurs after a transaction has been completed via the COMMIT operation.

public event SessionManipulationEventHandler AfterCommitTransaction

Event Type

SessionManipulationEventHandler

AfterConnect

Occurs after a connection to a database has been established.

public event SessionManipulationEventHandler AfterConnect

Event Type

SessionManipulationEventHandler

AfterDisconnect

Occurs when a connection to a database is closed.

public event SessionManipulationEventHandler AfterDisconnect

Event Type

SessionManipulationEventHandler

AfterDropChanges

Occurs after a list of tracked changes has been cleared.

public event SessionManipulationEventHandler AfterDropChanges

Event Type

SessionManipulationEventHandler

AfterFlushChanges

Occurs after tracked changes have been temporarily saved to a data store.

public event SessionManipulationEventHandler AfterFlushChanges

Event Type

SessionManipulationEventHandler

AfterRollbackTransaction

Occurs after a transaction has been completed via the ROLLBACK operation.

public event SessionManipulationEventHandler AfterRollbackTransaction

Event Type

SessionManipulationEventHandler

BeforeBeginTrackingChanges

Occurs when a transaction (a database level transaction in an explicit unit of work) is about to be started to track changes made to persistent objects.

public event SessionManipulationEventHandler BeforeBeginTrackingChanges

Event Type

SessionManipulationEventHandler

BeforeBeginTransaction

Occurs when a transaction is about to be started via the BEGIN operation.

public event SessionManipulationEventHandler BeforeBeginTransaction

Event Type

SessionManipulationEventHandler

BeforeCommitTransaction

Occurs when a transaction is about to be completed via the COMMIT operation.

public event SessionManipulationEventHandler BeforeCommitTransaction

Event Type

SessionManipulationEventHandler

BeforeConnect

Occurs before the connection to a database is established.

public event SessionManipulationEventHandler BeforeConnect

Event Type

SessionManipulationEventHandler

BeforeDisconnect

Occurs before the connection to a database is detached.

public event SessionManipulationEventHandler BeforeDisconnect

Event Type

SessionManipulationEventHandler

BeforeDropChanges

Occurs when a list of tracked changes is about to be cleared.

public event SessionManipulationEventHandler BeforeDropChanges

Event Type

SessionManipulationEventHandler

BeforeFlushChanges

Occurs when tracked changes are about to be temporarily saved to a data store.

public event SessionManipulationEventHandler BeforeFlushChanges

Event Type

SessionManipulationEventHandler

BeforeRollbackTransaction

Occurs when a transaction is about to be completed via the ROLLBACK operation.

public event SessionManipulationEventHandler BeforeRollbackTransaction

Event Type

SessionManipulationEventHandler

FailedCommitTransaction

Occurs when the Commit Transaction operation fails due to database constraints or other circumstances.

public event SessionOperationFailEventHandler FailedCommitTransaction

Event Type

SessionOperationFailEventHandler

FailedFlushChanges

Occurs when the Flush Changes operation fails due to database constraints or other circumstances.

public event SessionOperationFailEventHandler FailedFlushChanges

Event Type

SessionOperationFailEventHandler

ObjectChanged

Occurs after an object’s property has been changed.

public event ObjectChangeEventHandler ObjectChanged

Event Type

ObjectChangeEventHandler

ObjectDeleted

Occurs after an object has been deleted.

public event ObjectManipulationEventHandler ObjectDeleted

Event Type

ObjectManipulationEventHandler

ObjectDeleting

Occurs when an object is about to be deleted.

public event ObjectManipulationEventHandler ObjectDeleting

Event Type

ObjectManipulationEventHandler

ObjectLoaded

Occurs after an object’s properties have been initialized with values from a data store.

public event ObjectManipulationEventHandler ObjectLoaded

Event Type

ObjectManipulationEventHandler

ObjectLoading

Occurs when an object’s properties are about to be initialized with values from a data store.

public event ObjectManipulationEventHandler ObjectLoading

Event Type

ObjectManipulationEventHandler

ObjectSaved

Occurs after an object has been saved to a data store.

public event ObjectManipulationEventHandler ObjectSaved

Event Type

ObjectManipulationEventHandler

ObjectSaving

Occurs when an object is about to be saved to a data store.

public event ObjectManipulationEventHandler ObjectSaving

Event Type

ObjectManipulationEventHandler

ObjectsLoaded

Occurs after persistent objects have been initialized with values from a data store.

public event ObjectsManipulationEventHandler ObjectsLoaded

Event Type

ObjectsManipulationEventHandler

ObjectsSaved

Occurs after persistent objects have been saved to a data store.

public event ObjectsManipulationEventHandler ObjectsSaved

Event Type

ObjectsManipulationEventHandler