Session.GetObjectByKey<ClassType>(Object) 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
)

VB.NET

Public Function GetObjectByKey(Of ClassType)(
    id As Object
) As ClassType

Parameters

Name	Type	Description
id	Object	An object that represents the persistent object’s key property value.

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);
session.Delete(personToDelete);

VB.NET

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

The GetObjectByKey<ClassType> method searches the memory for the object that has the specified value for its key property. If such an object is found, it is not reloaded. To get the up-to-date object from the storage, use the overloaded Session.GetObjectByKey method with the alwaysGetFromDb parameter 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) 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#

wpf-data-grid-implement-crud-operations/CS/CodeBehind/XPO/ServerMode/MainWindow.xaml.cs#L43

    ? new Issue(unitOfWork)
    : unitOfWork.GetObjectByKey<Issue>(e.Key);
e.ViewModel = new EditItemViewModel(

XPO_how-to-implement-odata4-service-with-xpo/CS/ODataService/Helpers/ApiHelper.cs#L16

using(UnitOfWork uow = ConnectionHelper.CreateSession()) {
    TEntity existing = uow.GetObjectByKey<TEntity>(key);
    if(existing != null) {

reporting-mvc-db-storage/CS/DXWebApplication_ReportDesigner/CustomReportStorageWebExtension.cs#L16

using (var session = SessionFactory.Create()) {
    return session.GetObjectByKey<ReportEntity>(url) != null;
}

CriteriaOperatorsCheatSheet/CS/CriteriaOperatorCheatSheet/Tests/ComplexScenarios/SpecificObjectTest.cs#L36

//act
var obj = uow.GetObjectByKey<Order>(2);
var criterion = new BinaryOperator(nameof(OrderItem.Order), obj);

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

using(Session session = new Session(dataLayer)) {
    XpoServerId sid = session.GetObjectByKey<XpoServerId>(0);
    if(sid == null) {

VB.NET

reporting-mvc-db-storage/VB/DXWebApplication_ReportDesigner/CustomReportStorageWebExtension.vb#L18

Using session = SessionFactory.Create()
    Return session.GetObjectByKey(Of ReportEntity)(url) IsNot Nothing
End Using

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

Using session As New Session(dataLayer)
    Dim sid As XpoServerId = session.GetObjectByKey(Of XpoServerId)(0)
    If sid Is Nothing Then

XPO_how-to-reopen-a-broken-connection-when-using-a-postgresql-database-e3086/VB/Program.vb#L14

Console.ReadKey()
CType(New Session(dal), Session).GetObjectByKey(Of Person)(id)
DirectCast(dataStore, IDisposable).Dispose()

XPO_how-to-read-and-manipulate-xpo-objects-stored-in-multiple-databases-simultaneously-t475838/VB/ConsoleApplication/Model2.vb#L47

Public Function GetContact(ByVal foreignSession As Session) As Contact
    Return If(ContactID.HasValue, foreignSession.GetObjectByKey(Of Contact)(ContactID), Nothing)
End Function

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

'Get selected person object.
Dim person As Person = explicitUnitOfWork.GetObjectByKey(Of Person)(selectedRow("Oid"))
If person Is Nothing OrElse person.Address Is Nothing Then