Session.GetObjectByKey<ClassType>(Object, Boolean) Method

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

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

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

VB.NET

Public Function GetObjectByKey(Of ClassType)(
    id As Object,
    alwaysGetFromDataStore As Boolean
) As ClassType

Parameters

Name	Type	Description
id	Object	An object that represents the persistent object’s key property value.
alwaysGetFromDataStore	Boolean	true, to reload the persistent object from storage if it is found in memory; otherwise, false.

Type Parameters

Name	Description
ClassType	A type of objects to search for.

Returns

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

Remarks

Below is an example of using the GetObjectByKey<ClassType> method. Here, session is the Session instance.

C#

using DevExpress.Xpo;
// ...
Person personToDelete = session.GetObjectByKey<Person>(152, true);
session.Delete(personToDelete);

VB.NET

Imports DevExpress.Xpo
' ...
Dim personToDelete As Person = session.GetObjectByKey(Of Person)(152, True)
session.Delete(personToDelete)

Firstly, the GetObjectByKey<ClassType> method searches the memory for the object with the specified value of the key property. If such an object is found, it is not reloaded. To get the up-to-date object from the data store, the alwaysGetFromDb parameter must be set to true.

Note

The GetObjectByKey<ClassType> method does not find objects until they are saved to a data store.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetObjectByKey<ClassType>(Object, Boolean) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XPO_how-to-make-user-friendly-object-identifiers-e825/CS/XpoServerId.cs#L45

catch {
    sid = session.GetObjectByKey<XpoServerId>(0, true);
    if(sid == null)

XPO_how-to-generate-a-sequential-number-for-a-business-object-within-a-database-transaction-e2620/CS/ExplicitUnitOfWorkDemo/SequenceGenerator.cs#L25

if(seq == null) {
    seq = euow.GetObjectByKey<Sequence>(classInfo.FullName, true);
    if(seq == null) {

VB.NET

XPO_how-to-make-user-friendly-object-identifiers-e825/VB/XpoServerId.vb#L54

Catch
    sid = session.GetObjectByKey(Of XpoServerId)(0, True)
    If sid Is Nothing Then

XPO_how-to-generate-a-sequential-number-for-a-business-object-within-a-database-transaction-e2620/VB/ExplicitUnitOfWorkDemo/SequenceGenerator.vb#L27

If seq Is Nothing Then
    seq = euow.GetObjectByKey(Of Sequence)(classInfo.FullName, True)
    If seq Is Nothing Then