BaseObjectSpace.GetObjectByKey<ObjectType>(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.ExpressApp

Assembly: DevExpress.ExpressApp.v24.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public ObjectType GetObjectByKey<ObjectType>(
    object key
)

VB.NET

Public Function GetObjectByKey(Of ObjectType)(
    key As Object
) As ObjectType

Parameters

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

Type Parameters

Name
ObjectType

Returns

Type	Description
ObjectType	A persistent object with the specified value for its key property.

Remarks

To return an object retrieved by the specified key, the GetObjectByKey<ObjectType> method invokes the BaseObjectSpace.GetObjectByKey method, passing the required key as the key parameter. The value returned by the invoked method is cast to the type designated by the specified generic type parameter. Note that the invoked BaseObjectSpace.GetObjectByKey method does nothing and returns null (Nothing in VB). So, it should be overridden in the BaseObjectSpace class’ descendants.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetObjectByKey<ObjectType>(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#

XAF_Non-Persistent-Objects-Nested-In-Persistent-Objects-Demo/CS/NonPersistentObjectsDemo.Module/BusinessObjects/CollectionComplete/Feature.cs#L80

    var ownerObjectSpace = ObjectSpace.Owner as CompositeObjectSpace;
    return (ownerObjectSpace ?? ObjectSpace).GetObjectByKey<Project>(key);
}

VB.NET

XAF_Non-Persistent-Objects-Nested-In-Persistent-Objects-Demo/VB/NonPersistentObjectsDemo.Module/BusinessObjects/CollectionComplete/Feature.vb#L103

    Dim ownerObjectSpace = TryCast(ObjectSpace.Owner, CompositeObjectSpace)
    Return (If(ownerObjectSpace, ObjectSpace)).GetObjectByKey(Of Project)(key)
End Function

Implements

GetObjectByKey<ObjectType>(Object)