PersistentBase.IsLoading Property

Indicates whether the object is currently being initialized.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

[MemberDesignTimeVisibility(false)]
[Browsable(false)]
public bool IsLoading { get; }

VB.NET

<MemberDesignTimeVisibility(False)>
<Browsable(False)>
Public ReadOnly Property IsLoading As Boolean

Property Value

Type	Description
Boolean	true if the object is currently being initialized; otherwise, false.

Remarks

While XPO is modifying an object, the object is considered to be initialized. While an object is in this state, you shouldn’t access its properties or change the property values. The object is considered to be initialized in the following cases:

• The object is being loaded from a data source.
• The parent session (or unit of work) gets the changes made within its nested session.
• Data editing has been canceled.
• The optimistic concurrency and autogenerated key(s) are being processed.

If you need to enforce a business rule in a persistent class’ property setter or getter, ensure that the object is not currently being initialized. The following code snippet illustrates this.

C#

public class Order : XPObject {
    // ...
    private decimal fTotal;
    public decimal Total {
        get { return fTotal; }
        set {
            SetPropertyValue(nameof(Total), ref fTotal, value);
            if(!IsLoading && !IsSaving) {
                EnforceBusinessRule();            
            }
        }
    }
}

VB.NET

Public Class Order
    Inherits XPObject
    ' ...
    Private fTotal As Decimal
    Public Property Total() As Decimal
        Get
            Return fTotal
        End Get
        Set(ByVal value As Decimal)
            SetPropertyValue(NameOf(Total), fTotal, value)
            If (Not IsLoading) AndAlso (Not IsSaving) Then
                EnforceBusinessRule()
            End If
        End Set
    End Property
End Class