Skip to main content
All docs
V25.1
  • .NET 8.0+

    DevExpress v25.1 Update — Your Feedback Matters

    Our What's New in v25.1 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

    Take the survey Not interested

    XPObjectSpace.GetObjectAsync(Object, CancellationToken) Method

    Asynchronously retrieves an object that corresponds to an IObjectRecord wrapper or object from another Object Space.

    Namespace: DevExpress.ExpressApp.Xpo

    Assembly: DevExpress.ExpressApp.Xpo.v25.1.dll

    NuGet Package: DevExpress.ExpressApp.Xpo

    #Declaration

    public Task<object> GetObjectAsync(
        object obj,
        CancellationToken cancellationToken = default(CancellationToken)
    )

    #Parameters

    Name Type Description
    obj Object

    An object that represents a template object from another Object Space.

    #Optional Parameters

    Name Type Default Description
    cancellationToken CancellationToken null

    A CancellationToken object that delivers a cancellation notice to the running operation.

    #Returns

    Type Description
    Task<Object>

    A Task that returns an object. This object represents the evaluated value.

    #Remarks

    This method retrieves the object specified as the obj parameter from the database via the current Object Space’s XPObjectSpace.Session. If the passed object is not persistent, it’s returned as is.

    The following code demonstrates how you can use this method in a View Controller to find and show a Contact the selected DemoTask is assigned to. If this DemoTask is not assigned to any Contact, a Detail View for a new Contact object is shown.

    using DevExpress.ExpressApp;
    using DevExpress.ExpressApp.Actions;
    using DevExpress.ExpressApp.Xpo;
    using System;
    using System.Threading;
    // ...
    public class AsyncAssignedToInfoController : ObjectViewController<ListView, DemoTask> {
        View contactView = null;
        public AsyncAssignedToInfoController() : base() {
            SimpleAction showAssignedToInfoAction = new SimpleAction(this, "Assigned contact's info", "Edit");
            showAssignedToInfoAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject;
            showAssignedToInfoAction.Execute += showAssignedToInfoAction_Execute;
        }
        async private void showAssignedToInfoAction_Execute(object sender, SimpleActionExecuteEventArgs e) {
            CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
            XPObjectSpace contactObjectSpace = (XPObjectSpace)Application.CreateObjectSpace(typeof(Contact));
            contactView = Application.CreateDetailView(contactObjectSpace, "Contact_DetailView", true);
            e.ShowViewParameters.CreatedView = contactView;
            Contact assignedTo = (Contact)ViewCurrentObject.AssignedTo;
                if (assignedTo != null) {
                    object obj = await contactObjectSpace.GetObjectAsync(assignedTo, cancellationTokenSource.Token);
                    contactView.CurrentObject = obj ?? contactObjectSpace.CreateObject(typeof(Contact));
                }
                else {
                    contactView.CurrentObject = contactObjectSpace.CreateObject(typeof(Contact));
                }
            if (contactObjectSpace.IsNewObject(contactView.CurrentObject)) {
                contactObjectSpace.Committed += contactObjectSpace_Committed;
            }
        }
        private void contactObjectSpace_Committed(object sender, EventArgs e) {
            ViewCurrentObject.AssignedTo = ObjectSpace.GetObject(contactView.CurrentObject) as Contact;
        }
    }
    

    In the current example, the cancellationToken parameter is used for demonstration purposes. You can skip it or use to cancel an asynchronous operation as shown in the CancellationToken topic.

    See Also