CompositeObjectSpace.PopulateAdditionalObjectSpaces(XafApplication) Method

Creates Object Spaces for registered Object Space Providers and adds them to the AdditionalObjectSpaces collection. Object Spaces in this collection are automatically disposed of with the owner Object Space.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v20.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public void PopulateAdditionalObjectSpaces(
    XafApplication application
)

VB.NET

Public Sub PopulateAdditionalObjectSpaces(
    application As XafApplication
)

Parameters

Name	Type	Description
application	XafApplication	An XAF application instance where Object Space Providers are registered.

Remarks

Follow the steps below to use this method:

1. Handle the XafApplication.ObjectSpaceCreated event in a module or Controller.
2. In the event handler, call the PopulateAdditionalObjectSpaces(XafApplication) method to populate the AdditionalObjectSpaces collection with all necessary Object Spaces.

The following example demonstrates how to do this in a platform-agnostic module (MySolution.Module/Module.cs(vb)):

C#

using DevExpress.ExpressApp;
//...
public class MySolutionModule : ModuleBase {
    //...
    public override void Setup(XafApplication application) {
        base.Setup(application);
        application.ObjectSpaceCreated += Application_ObjectSpaceCreated;
    }
    private void Application_ObjectSpaceCreated(object sender, ObjectSpaceCreatedEventArgs e) {
        CompositeObjectSpace compositeObjectSpace = e.ObjectSpace as CompositeObjectSpace;
        if (compositeObjectSpace != null) {
            if (!(compositeObjectSpace.Owner is CompositeObjectSpace)) {
                compositeObjectSpace.PopulateAdditionalObjectSpaces((XafApplication)sender);
            }
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp
'...
Public Class MySolutionModule
    Inherits ModuleBase

    '...
    Public Overrides Sub Setup(ByVal application As XafApplication)
        MyBase.Setup(application)
        AddHandler application.ObjectSpaceCreated, AddressOf Application_ObjectSpaceCreated
    End Sub
    Private Sub Application_ObjectSpaceCreated(ByVal sender As Object, ByVal e As ObjectSpaceCreatedEventArgs)
        Dim compositeObjectSpace As CompositeObjectSpace = TryCast(e.ObjectSpace, CompositeObjectSpace)
        If compositeObjectSpace IsNot Nothing Then
            If Not (TypeOf compositeObjectSpace.Owner Is CompositeObjectSpace) Then
                compositeObjectSpace.PopulateAdditionalObjectSpaces(DirectCast(sender, XafApplication))
            End If
        End If
    End Sub
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PopulateAdditionalObjectSpaces(XafApplication) 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/Module.cs#L45

if(!(cos.Owner is CompositeObjectSpace)) {
    cos.PopulateAdditionalObjectSpaces((XafApplication)sender);
    cos.AutoCommitAdditionalObjectSpaces = true;

VB.NET

XAF_Non-Persistent-Objects-Nested-In-Persistent-Objects-Demo/VB/NonPersistentObjectsDemo.Module/Module.vb#L47

If Not (TypeOf cos.Owner Is CompositeObjectSpace) Then
    cos.PopulateAdditionalObjectSpaces(DirectCast(sender, XafApplication))
    cos.AutoCommitAdditionalObjectSpaces = True