XPBaseObject Class

Serves as a base for classes that represent persistent objects.

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

Declaration

C#
VB.NET

[NonPersistent]
[MemberDesignTimeVisibility(false)]
[OptimisticLocking(true)]
public abstract class XPBaseObject :
    PersistentBase,
    IEditableObject,
    ICustomTypeDescriptor,
    IComparable,
    IXPReceiveOnChangedFromXPPropertyDescriptor

<NonPersistent>
<MemberDesignTimeVisibility(False)>
<OptimisticLocking(True)>
Public MustInherit Class XPBaseObject
    Inherits PersistentBase
    Implements IEditableObject,
               ICustomTypeDescriptor,
               IComparable,
               IXPReceiveOnChangedFromXPPropertyDescriptor

Remarks

The XPBaseObject class automatically supports the optimistic concurrency feature. If this feature is not required, you can use the XPLiteObject class instead.

When creating a persistent object by deriving from the XPBaseObject, XPCustomObject or XPObject class, an OptimisticLockingAttribute is automatically applied to it. This attribute specifies whether a session can lock a persistent object’s state (allows optimistic locking to be enabled). For more information, see XPObject and Optimistic Concurrency.

The following code demonstrates how to declare a persistent object.

C#
VB.NET

using DevExpress.Xpo;
using System.ComponentModel;

// Other base classes: https://docs.devexpress.com/eXpressAppFramework/113146/concepts/business-model-design/business-model-design-with-xpo/base-persistent-classes

public class MyClass : XPBaseObject {
    public MyClass(Session session) : base(session) { }
    // XPBaseObject does not have a built-in key and you need to add your own key
    [Key(AutoGenerate = true), Browsable(false)]
    public int Oid { get; set; }
    string fMyProperty;
    public string MyProperty {
        get { return fMyProperty; }
        set { SetPropertyValue(nameof(MyProperty), ref fMyProperty, value); }
    }
}

Imports System.ComponentModel
Imports DevExpress.Xpo

' Other base classes: https://docs.devexpress.com/eXpressAppFramework/113146/concepts/business-model-design/business-model-design-with-xpo/base-persistent-classes

Public Class [MyClass]
    Inherits XPBaseObject
    Public Sub New(ByVal session As Session)
        MyBase.New(session)
    End Sub
    ' XPBaseObject does not have a built-in key and you need to add your own key
    <Key(AutoGenerate:=True)>
    <Browsable(False)>
    Public Property Oid() As Integer
    Private fMyProperty As String
    Public Property MyProperty() As String
        Get
            Return fMyProperty
        End Get
        Set(ByVal value As String)
            SetPropertyValue(NameOf(MyProperty), fMyProperty, value)
        End Set
    End Property
End Class