BaseObject(Session) Constructor

Used to initialize a new instance of a BaseObject descendant, in a particular Session.

Namespace: DevExpress.Persistent.BaseImpl

Assembly: DevExpress.Persistent.BaseImpl.Xpo.v24.1.dll

NuGet Package: DevExpress.Persistent.BaseImpl.Xpo

Declaration

C#

public BaseObject(
    Session session
)

VB.NET

Public Sub New(
    session As Session
)

Parameters

Name	Type	Description
session	Session	A DevExpress.Xpo.Session object which represents a persistent object’s cache where the business object will be instantiated.

Remarks

The eXpress Persistent Objects, an object persistence framework used by XAF, demands that each persistent object must be tied to a Session. So, when implementing a business class derived from the BaseObject class, ensure that the business class has a constructor which takes a Session-type parameter and passes it to the BaseObject class constructor. If you create a new business object declaration in an XAF application via the XAF Business Object | XPO Business Object template, the created declaration automatically contains such a constructor:

C#

[DefaultClassOptions]
    public class MyDomainObject : BaseObject {
        public MyDomainObject(Session session) : base(session) { }
}

VB.NET

<DefaultClassOptions()> _
Public Class MyDomainObject
    Inherits BaseObject
    Public Sub New(ByVal session As Session)
        MyBase.New(session)
    End Sub
End Class

Note

XAF manages persistent objects via Object Spaces (see XPObjectSpace). An Object Space exposes a Session object via its XPObjectSpace.Session property. So, if you need to create a new Session to interact with the database used by an XAF application, instantiate an XPObjectSpace via the XafApplication.CreateObjectSpace method, and use its XPObjectSpace.Session property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BaseObject(Session) constructor.

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.

VB.NET

xaf-how-to-use-tree-list-editors-to-display-list-views/VB/HowToUseTreeListEditor.Module/Issue.vb#L20

Public Sub New(ByVal session As Session)
    MyBase.New(session)
End Sub

xaf-how-to-show-persistent-objects-in-a-non-persistent-objects-view/VB/ComplexDialogSample.Module/BusinessObjects/BusinessObjects.vb#L14

Public Sub New(ByVal session As Session)
    MyBase.New(session)
End Sub

XAF_Non-Persistent-Objects-Nested-In-Persistent-Objects-Demo/VB/NonPersistentObjectsDemo.Module/BusinessObjects/LookupWithCustomSource/Product.vb#L23

Public Sub New(ByVal session As Session)
    MyBase.New(session)
End Sub

XAF_how-to-show-filter-dialog-before-listview/VB/E1554.Module/ViewFilterObject.vb#L14

Public Sub New(ByVal session As Session)
    MyBase.New(session)
End Sub

XAF_Non-Persistent-Objects-Reloading-Demo/VB/NonPersistentObjectsDemo.Module/BusinessObjects/PersistentObjects.vb#L18

Public Sub New(ByVal session As Session)
    MyBase.New(session)
End Sub