IObjectSpace.GetObjectByHandle(String) Method

Returns the object with the specified handle.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

object GetObjectByHandle(
    string handle
)

VB.NET

Function GetObjectByHandle(
    handle As String
) As Object

Parameters

Name	Type	Description
handle	String	A string holding the key property value and type of the specified object, representing the handle of the object that will be retrieved.

Returns

Type	Description
Object	An object which has the specified handle.

Remarks

The object handle is a string of the following format:

Solution1.Module.BusinessObjects.MyEntityObject(1)

Here, Solution1.Module.BusinessObjects.MyEntityObject is the FullName of the object type and 1 is the object’s key property value. To get the handle of an existing object, use the IObjectSpace.GetObjectHandle method.

When implementing the IObjectSpace interface in the BaseObjectSpace class’s descendant, don’t implement the GetObjectByHandle method. It’s implemented in the BaseObjectSpace class. The BaseObjectSpace.GetObjectByHandle method parses the handler passed as the handle parameter using the DevExpress.ExpressApp.ObjectHandleHelper class and calls the BaseObjectSpace.GetObjectByKey method to get the object to return.