Session.GetObjectByKey(XPClassInfo, Object) Method

Returns a persistent object with the specified value of the 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 object GetObjectByKey(
    XPClassInfo classInfo,
    object id
)

VB.NET

Public Function GetObjectByKey(
    classInfo As XPClassInfo,
    id As Object
) As Object

Parameters

Name	Type	Description
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

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

Remarks

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

C#

using DevExpress.Xpo;
using DevExpress.Xpo.Metadata;
// ...
XPClassInfo personClassInfo = session.GetClassInfo(typeof(Person));
Person personToDelete = (Person)session.GetObjectByKey(personClassInfo, 152);
personToDelete.Delete();

VB.NET

Imports DevExpress.Xpo
Imports DevExpress.Xpo.Metadata
' ...
Private personClassInfo As XPClassInfo = session.GetClassInfo(GetType(Person))
Private personToDelete As Person = CType(session.GetObjectByKey(personClassInfo, 152), Person)
personToDelete.Delete()

Firstly, the GetObjectByKey method searches in 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, use the overloaded Session.GetObjectByKey method with the alwaysGetFromDb parameter set to true.

Note

The GetObjectByKey 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(XPClassInfo, Object) 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-implement-odata4-service-with-xpo/CS/ODataService/Helpers/ApiHelper.cs#L50

if(memberInfo.IsAssociationList) {
    var reference = uow.GetObjectByKey(memberInfo.CollectionElementType, relatedKey);
    var collection = (IList)memberInfo.GetValue(entity);

XPO_how-to-clone-a-persistent-object-e804/CS/SimpleObject/CloneHelper.cs#L77

if (synchronize && !cloneAlways) {
    clonedValue = targetSession.GetObjectByKey(targetSession.GetClassInfo(propertyValue), targetSession.GetKeyValue(propertyValue));
}

VB.NET

XPO_how-to-clone-a-persistent-object-e804/VB/SimpleObject/CloneHelper.vb#L80

If synchronize AndAlso (Not cloneAlways) Then
    clonedValue = targetSession.GetObjectByKey(targetSession.GetClassInfo(propertyValue), targetSession.GetKeyValue(propertyValue))
End If