Практическое руководство. Реализация уведомления об изменении свойства

  • Статья

Для поддержки привязки OneWay или TwoWay, чтобы задать свойствам целевого объекта привязки автоматическое отражение динамических изменений источника привязки (например, чтобы область просмотра обновлялась автоматически, когда пользователь редактирует форму), ваш класс должен предоставлять уведомления о соответствующих изменениях свойства. В этом примере показано, как создать класс, реализующий INotifyPropertyChanged.

Пример

Чтобы реализовать INotifyPropertyChanged, вы должны объявить событие PropertyChangedи создать метод OnPropertyChanged. Затем для каждого свойства, которому потребуются уведомления об изменениях, вы вызываете OnPropertyChanged при каждом обновлении свойства.

using System.ComponentModel;
using System.Runtime.CompilerServices;

namespace SDKSample
{
  // This class implements INotifyPropertyChanged
  // to support one-way and two-way bindings
  // (such that the UI element updates when the source
  // has been changed dynamically)
  public class Person : INotifyPropertyChanged
  {
      private string name;
      // Declare the event
      public event PropertyChangedEventHandler PropertyChanged;

      public Person()
      {
      }

      public Person(string value)
      {
          this.name = value;
      }

      public string PersonName
      {
          get { return name; }
          set
          {
              name = value;
              // Call OnPropertyChanged whenever the property is updated
              OnPropertyChanged();
          }
      }

      // Create the OnPropertyChanged method to raise the event
      // The calling member's name will be used as the parameter.
      protected void OnPropertyChanged([CallerMemberName] string name = null)
      {
          PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(name));
      }
  }
}

Imports System.ComponentModel
Imports System.Runtime.CompilerServices

' This class implements INotifyPropertyChanged
' to support one-way and two-way bindings
' (such that the UI element updates when the source
' has been changed dynamically)
Public Class Person
    Implements INotifyPropertyChanged

    Private personName As String

    Sub New()
    End Sub

    Sub New(ByVal Name As String)
        Me.personName = Name
    End Sub

    ' Declare the event
    Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged

    Public Property Name() As String
        Get
            Return personName
        End Get
        Set(ByVal value As String)
            personName = value
            ' Call OnPropertyChanged whenever the property is updated
            OnPropertyChanged()
        End Set
    End Property

    ' Create the OnPropertyChanged method to raise the event
    ' Use the name of the member that called this method in place of name
    Protected Sub OnPropertyChanged(<CallerMemberName> Optional name As String = Nothing)
        RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(name))
    End Sub

End Class

Чтобы посмотреть пример того, как класс Person может использоваться для поддержки привязки TwoWay, см. Управление обновлением источника из поля TextBox.

См. также