PropertyChanged Event in Business Classes

• Mar 13, 2021
• 3 minutes to read

To provide a consistent user interface, your XAF application must receive notifications from business classes when their property values are changed. For instance, Conditional Appearance and Validation modules may require an immediate UI update when a user modifies a certain value. This topic describes how to provide notifications from XPO, Entity Framework and non-persistent business classes.

The notification mechanism is based on supporting the standard INotifyPropertyChanged interface and implementing its declared PropertyChanged event. To send a notification to internal XAF code, trigger PropertyChanged from a property set accessor within a business class.

PropertyChanged Event in XPO

There is no need to implement the INotifyPropertyChanged interface manually in an XPO business class. When you declare an XPO business class, you inherit BaseObject (or another base persistent class) that already supports this interface. You can trigger the PropertyChanged event from a property set accessor by executing the XPBaseObject.OnChanged or PersistentBase.SetPropertyValue helper method.

C#

public class Department : BaseObject {
    // ...
    private string title;
    public string Title {
        get {
            return title;
        }
        set {
            SetPropertyValue(nameof(Title), ref title, value);
        }
    }
}

VB.NET

Public Class Department
    Inherits BaseObject
    ' ...
    Private _title As String
    Public Property Title() As String
        Get
            Return _title
        End Get
        Set(ByVal value As String)
            SetPropertyValue(NameOf(Title), _title, value)
        End Set
    End Property
End Class

See Also: Simplified Property Syntax

PropertyChanged Event in Entity Framework

When implementing an EntityFramework business class, you do not inherit any standard base class. Thus, you should implement the INotifyPropertyChanged interface manually. XAF provides the XAF Business Object | EF Business Object project item template to simplify this task.

In an existing class, you can implement INotifyPropertyChanged as follows.

C#

public class Customer : INotifyPropertyChanged {
    // ...
    public event PropertyChangedEventHandler PropertyChanged;
    protected void OnPropertyChanged([System.Runtime.CompilerServices.CallerMemberName] string propertyName = null) {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }
}

VB.NET

Public Class Customer
    Implements INotifyPropertyChanged
    ' ...
    Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged
    Protected Sub OnPropertyChanged( _
        <System.Runtime.CompilerServices.CallerMemberName> Optional propertyName As String = Nothing)
        Dim args As New PropertyChangedEventArgs(propertyName)
        RaiseEvent PropertyChanged(Me, args)
    End Sub
End Class

You can use the OnPropertyChanged helper method to trigger the PropertyChanged event from a property set accessor.

C#

public class Customer : INotifyPropertyChanged {
    // ...
    private CustomerStatus status;
        public CustomerStatus Status {
        get { return status; }
        set {
            if(status != value) {
                status = value;
                OnPropertyChanged();
            }
        }
    }
}

VB.NET

Public Class Customer
    Implements INotifyPropertyChanged
    ' ...
    Private _status As CustomerStatus
        Public Property Status() As CustomerStatus
        Get
            Return _status
        End Get
        Set(ByVal value As CustomerStatus)
            If _status IsNot value Then
                _status = value
                OnPropertyChanged()
            End If
        End Set
        End Property
End Class

PropertyChanged Event in Non-Persistent Classes

To use the PropertyChanged event in a non-persistent class, follow the same approach which is described above for the Entity Framework.

C#

public class NonPersistentObject1 : INotifyPropertyChanged {
    // ...
    private string sampleProperty; 
    public string SampleProperty {
        get { return sampleProperty; }
        set {
            if (sampleProperty != value) {
                sampleProperty = value;
                OnPropertyChanged();
            }
        }
    }
    private void OnPropertyChanged([System.Runtime.CompilerServices.CallerMemberName] string propertyName = null) {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }
    public event PropertyChangedEventHandler PropertyChanged;
}

VB.NET

Public Class NonPersistentObject1
    Implements INotifyPropertyChanged
    ' ...
    Private _sampleProperty As String
    Public Property SampleProperty() As String
        Get
            Return _sampleProperty
        End Get
        Set(ByVal value As String)
            If _sampleProperty <> value Then
                _sampleProperty = value
                OnPropertyChanged()
            End If
        End Set
    End Property
    Private Sub OnPropertyChanged( _
        <System.Runtime.CompilerServices.CallerMemberName> Optional propertyName As String = Nothing)
        RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(propertyName))
    End Sub
    Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged
End Class

To create a new non-persistent class that supports INotifyPropertyChanged, use the XAF Business Object | Non-Persistent Object project item template.