IObjectSpace.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.v18.2.dll

Declaration

C#

ObjectType GetObjectByKey<ObjectType>(
    object key
)

VB.NET

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

Parameters

Name	Type	Description
key	Object	An object that represents 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

When implementing the IObjectSpace interface in the BaseObjectSpace class’s descendant, don’t implement the GetObjectByKey<ObjectType> method. It’s implemented in the BaseObjectSpace class. The BaseObjectSpace.GetObjectByKey<ObjectType>(object key) method calls the BaseObjectSpace.GetObjectByKey(Type type, object key) method which returns null. The latter method is virtual. So, you should override it in your descendant.

To get the key property value, use the IObjectSpace.GetKeyValue method.

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_how-to-apply-another-appearance-to-reviewed-objects-e1386/CS/DXExample.Module/MarkAsReadViewController.cs#L27

private void AddObjectToUserBOs(bool commitChanges) {
    MySimpleUser currentUser = ObjectSpace.GetObjectByKey<MySimpleUser>(SecuritySystem.CurrentUserId);
    BaseClass currentObject = (BaseClass)View.CurrentObject;

VB.NET

XAF_how-to-apply-another-appearance-to-reviewed-objects-e1386/VB/DXExample.Module/MarkAsReadViewController.vb#L29

Private Sub AddObjectToUserBOs(ByVal commitChanges As Boolean)
    Dim currentUser As MySimpleUser = ObjectSpace.GetObjectByKey(Of MySimpleUser)(SecuritySystem.CurrentUserId)
    Dim currentObject As BaseClass = CType(View.CurrentObject, BaseClass)