Projektowanie wspaniałych źródeł danych za pomocą powiadomienia o zmianie (Windows Forms .NET)
Jednym z najważniejszych pojęć związanych z powiązaniem danych formularzy systemu Windows jest powiadomienie o zmianie. Aby zapewnić, że źródło danych i powiązane kontrolki zawsze mają najnowsze dane, należy dodać powiadomienie o zmianie powiązania danych. W szczególności chcesz mieć pewność, że powiązane kontrolki są powiadamiane o zmianach wprowadzonych w źródle danych. Źródło danych jest powiadamiane o zmianach wprowadzonych we powiązanych właściwościach kontrolki.
Istnieją różne rodzaje powiadomień o zmianach w zależności od rodzaju powiązania danych:
Proste powiązanie, w którym jedna właściwość kontrolki jest powiązana z pojedynczym wystąpieniem obiektu.
Powiązanie oparte na liście, które może zawierać jedną właściwość kontrolki powiązaną z właściwością elementu na liście lub właściwość kontrolki powiązaną z listą obiektów.
Ponadto, jeśli tworzysz kontrolki formularzy systemu Windows, których chcesz użyć do powiązania danych, musisz zastosować wzorzec PropertyNameChanged do kontrolek. Zastosowanie wzorca do kontrolek powoduje propagację zmian w powiązanej właściwości kontrolki do źródła danych.
Powiadomienie o zmianie prostego powiązania
W przypadku prostego powiązania obiekty biznesowe muszą podać powiadomienie o zmianie, gdy wartość powiązanej właściwości ulegnie zmianie. Możesz podać powiadomienie o zmianie, ujawniając zdarzenie PropertyNameChanged dla każdej właściwości obiektu biznesowego. Wymaga również powiązania obiektu biznesowego z kontrolkami za pomocą BindingSource metody lub preferowanej metody, w której obiekt biznesowy implementuje INotifyPropertyChanged interfejs i zgłasza PropertyChanged zdarzenie, gdy wartość właściwości ulegnie zmianie. W przypadku używania obiektów implementujących INotifyPropertyChanged
interfejs nie trzeba używać BindingSource
elementu , aby powiązać obiekt z kontrolką. Jednak użycie elementu BindingSource
jest zalecane.
Powiadomienie o zmianie powiązania opartego na liście
Formularze systemu Windows zależą od powiązanej listy w celu zapewnienia zmian właściwości i informacji o zmianie listy powiązanych kontrolek. Zmiana właściwości to zmiana wartości właściwości elementu listy, a zmiana listy jest elementem usuniętym lub dodanym do listy. W związku z tym listy używane do powiązania danych muszą implementować IBindingListelement , który udostępnia oba typy powiadomień o zmianie. Jest BindingList<T> to ogólna implementacja IBindingList
i jest przeznaczona do użycia z powiązaniem danych windows Forms. Można utworzyć obiekt BindingList
zawierający typ obiektu biznesowego, który implementuje, a lista automatycznie konwertuje INotifyPropertyChangedPropertyChanged zdarzenia na ListChanged zdarzenia. Jeśli lista powiązana nie jest elementem IBindingList
, należy powiązać listę obiektów z kontrolkami Windows Forms przy użyciu BindingSource składnika . Składnik BindingSource
zapewni konwersję właściwości na listę podobną do konwersji .BindingList
Aby uzyskać więcej informacji, zobacz How to: Raise Change Notifications Using a BindingSource and the INotifyPropertyChanged Interface (Jak zgłaszać powiadomienia o zmianie przy użyciu elementu BindingSource) i INotifyPropertyChanged Interface (Interfejs INotifyPropertyChanged).
Powiadomienie o zmianie kontrolek niestandardowych
Na koniec po stronie kontrolki należy uwidocznić zdarzenie PropertyNameChanged dla każdej właściwości, która ma być powiązana z danymi. Zmiany właściwości kontrolki są następnie propagowane do powiązanego źródła danych. Aby uzyskać więcej informacji, zobacz Stosowanie wzorca PropertyNameChanged.
Stosowanie wzorca PropertyNameChanged
W poniższym przykładzie kodu pokazano, jak zastosować wzorzec PropertyNameChanged do kontrolki niestandardowej. Zastosuj wzorzec podczas implementowania kontrolek niestandardowych używanych z aparatem powiązania danych formularzy systemu Windows.
// This class implements a simple user control
// that demonstrates how to apply the propertyNameChanged pattern.
[ComplexBindingProperties("DataSource", "DataMember")]
public class CustomerControl : UserControl
{
private DataGridView dataGridView1;
private Label label1;
private DateTime lastUpdate = DateTime.Now;
public EventHandler DataSourceChanged;
public object DataSource
{
get
{
return this.dataGridView1.DataSource;
}
set
{
if (DataSource != value)
{
this.dataGridView1.DataSource = value;
OnDataSourceChanged();
}
}
}
public string DataMember
{
get { return this.dataGridView1.DataMember; }
set { this.dataGridView1.DataMember = value; }
}
private void OnDataSourceChanged()
{
if (DataSourceChanged != null)
{
DataSourceChanged(this, new EventArgs());
}
}
public CustomerControl()
{
this.dataGridView1 = new System.Windows.Forms.DataGridView();
this.label1 = new System.Windows.Forms.Label();
this.dataGridView1.ColumnHeadersHeightSizeMode =
System.Windows.Forms.DataGridViewColumnHeadersHeightSizeMode.AutoSize;
this.dataGridView1.ImeMode = System.Windows.Forms.ImeMode.Disable;
this.dataGridView1.Location = new System.Drawing.Point(100, 100);
this.dataGridView1.Size = new System.Drawing.Size(500,500);
this.dataGridView1.TabIndex = 1;
this.label1.AutoSize = true;
this.label1.Location = new System.Drawing.Point(50, 50);
this.label1.Name = "label1";
this.label1.Size = new System.Drawing.Size(76, 13);
this.label1.TabIndex = 2;
this.label1.Text = "Customer List:";
this.Controls.Add(this.label1);
this.Controls.Add(this.dataGridView1);
this.Size = new System.Drawing.Size(450, 250);
}
}
' This class implements a simple user control
' that demonstrates how to apply the propertyNameChanged pattern.
<ComplexBindingProperties("DataSource", "DataMember")>
Public Class CustomerControl
Inherits UserControl
Private dataGridView1 As DataGridView
Private label1 As Label
Private lastUpdate As DateTime = DateTime.Now
Public DataSourceChanged As EventHandler
Public Property DataSource() As Object
Get
Return Me.dataGridView1.DataSource
End Get
Set
If DataSource IsNot Value Then
Me.dataGridView1.DataSource = Value
OnDataSourceChanged()
End If
End Set
End Property
Public Property DataMember() As String
Get
Return Me.dataGridView1.DataMember
End Get
Set
Me.dataGridView1.DataMember = Value
End Set
End Property
Private Sub OnDataSourceChanged()
If (DataSourceChanged IsNot Nothing) Then
DataSourceChanged(Me, New EventArgs())
End If
End Sub
Public Sub New()
Me.dataGridView1 = New System.Windows.Forms.DataGridView()
Me.label1 = New System.Windows.Forms.Label()
Me.dataGridView1.ColumnHeadersHeightSizeMode =
System.Windows.Forms.DataGridViewColumnHeadersHeightSizeMode.AutoSize
Me.dataGridView1.ImeMode = System.Windows.Forms.ImeMode.Disable
Me.dataGridView1.Location = New System.Drawing.Point(19, 55)
Me.dataGridView1.Size = New System.Drawing.Size(550, 150)
Me.dataGridView1.TabIndex = 1
Me.label1.AutoSize = True
Me.label1.Location = New System.Drawing.Point(19, 23)
Me.label1.Name = "label1"
Me.label1.Size = New System.Drawing.Size(76, 13)
Me.label1.TabIndex = 2
Me.label1.Text = "Customer List:"
Me.Controls.Add(Me.label1)
Me.Controls.Add(Me.dataGridView1)
Me.Size = New System.Drawing.Size(650, 300)
End Sub
End Class
Implementowanie interfejsu INotifyPropertyChanged
W poniższym przykładzie kodu pokazano, jak zaimplementować INotifyPropertyChanged interfejs. Zaimplementuj interfejs na obiektach biznesowych używanych w powiązaniu danych formularzy systemu Windows. Po zaimplementowaniu interfejs komunikuje się z powiązana kontrolką, która zmienia właściwość obiektu biznesowego.
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Runtime.CompilerServices;
using System.Windows.Forms;
// Change the namespace to the project name.
namespace binding_control_example
{
// This form demonstrates using a BindingSource to bind
// a list to a DataGridView control. The list does not
// raise change notifications. However the DemoCustomer1 type
// in the list does.
public partial class Form3 : Form
{
// This button causes the value of a list element to be changed.
private Button changeItemBtn = new Button();
// This DataGridView control displays the contents of the list.
private DataGridView customersDataGridView = new DataGridView();
// This BindingSource binds the list to the DataGridView control.
private BindingSource customersBindingSource = new BindingSource();
public Form3()
{
InitializeComponent();
// Set up the "Change Item" button.
this.changeItemBtn.Text = "Change Item";
this.changeItemBtn.Dock = DockStyle.Bottom;
this.changeItemBtn.Height = 100;
//this.changeItemBtn.Click +=
// new EventHandler(changeItemBtn_Click);
this.Controls.Add(this.changeItemBtn);
// Set up the DataGridView.
customersDataGridView.Dock = DockStyle.Top;
this.Controls.Add(customersDataGridView);
this.Size = new Size(400, 200);
}
private void Form3_Load(object sender, EventArgs e)
{
this.Top = 100;
this.Left = 100;
this.Height = 600;
this.Width = 1000;
// Create and populate the list of DemoCustomer objects
// which will supply data to the DataGridView.
BindingList<DemoCustomer1> customerList = new ();
customerList.Add(DemoCustomer1.CreateNewCustomer());
customerList.Add(DemoCustomer1.CreateNewCustomer());
customerList.Add(DemoCustomer1.CreateNewCustomer());
// Bind the list to the BindingSource.
this.customersBindingSource.DataSource = customerList;
// Attach the BindingSource to the DataGridView.
this.customersDataGridView.DataSource =
this.customersBindingSource;
}
// Change the value of the CompanyName property for the first
// item in the list when the "Change Item" button is clicked.
void changeItemBtn_Click(object sender, EventArgs e)
{
// Get a reference to the list from the BindingSource.
BindingList<DemoCustomer1>? customerList =
this.customersBindingSource.DataSource as BindingList<DemoCustomer1>;
// Change the value of the CompanyName property for the
// first item in the list.
customerList[0].CustomerName = "Tailspin Toys";
customerList[0].PhoneNumber = "(708)555-0150";
}
}
// This is a simple customer class that
// implements the IPropertyChange interface.
public class DemoCustomer1 : INotifyPropertyChanged
{
// These fields hold the values for the public properties.
private Guid idValue = Guid.NewGuid();
private string customerNameValue = String.Empty;
private string phoneNumberValue = String.Empty;
public event PropertyChangedEventHandler PropertyChanged;
// This method is called by the Set accessor of each property.
// The CallerMemberName attribute that is applied to the optional propertyName
// parameter causes the property name of the caller to be substituted as an argument.
private void NotifyPropertyChanged([CallerMemberName] String propertyName = "")
{
if (PropertyChanged != null)
{
PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
}
}
// The constructor is private to enforce the factory pattern.
private DemoCustomer1()
{
customerNameValue = "Customer";
phoneNumberValue = "(312)555-0100";
}
// This is the public factory method.
public static DemoCustomer1 CreateNewCustomer()
{
return new DemoCustomer1();
}
// This property represents an ID, suitable
// for use as a primary key in a database.
public Guid ID
{
get
{
return this.idValue;
}
}
public string CustomerName
{
get
{
return this.customerNameValue;
}
set
{
if (value != this.customerNameValue)
{
this.customerNameValue = value;
NotifyPropertyChanged();
}
}
}
public string PhoneNumber
{
get
{
return this.phoneNumberValue;
}
set
{
if (value != this.phoneNumberValue)
{
this.phoneNumberValue = value;
NotifyPropertyChanged();
}
}
}
}
}
Imports System.Collections.Generic
Imports System.ComponentModel
Imports System.Drawing
Imports System.Runtime.CompilerServices
Imports System.Windows.Forms
' This form demonstrates using a BindingSource to bind
' a list to a DataGridView control. The list does not
' raise change notifications. However the DemoCustomer1 type
' in the list does.
Public Class Form3
Inherits System.Windows.Forms.Form
' This button causes the value of a list element to be changed.
Private changeItemBtn As New Button()
' This DataGridView control displays the contents of the list.
Private customersDataGridView As New DataGridView()
' This BindingSource binds the list to the DataGridView control.
Private customersBindingSource As New BindingSource()
Public Sub New()
InitializeComponent()
' Set up the "Change Item" button.
Me.changeItemBtn.Text = "Change Item"
Me.changeItemBtn.Dock = DockStyle.Bottom
Me.changeItemBtn.Size = New System.Drawing.Size(100, 100)
AddHandler Me.changeItemBtn.Click, AddressOf changeItemBtn_Click
Me.Controls.Add(Me.changeItemBtn)
' Set up the DataGridView.
customersDataGridView.Dock = DockStyle.Top
Me.Controls.Add(customersDataGridView)
Me.Size = New Size(400, 200)
End Sub
Private Sub Form3_Load(ByVal sender As System.Object,
ByVal e As System.EventArgs) Handles Me.Load
Me.Top = 100
Me.Left = 100
Me.Height = 600
Me.Width = 1000
' Create and populate the list of DemoCustomer1 objects
' which will supply data to the DataGridView.
Dim customerList As New BindingList(Of DemoCustomer1)
customerList.Add(DemoCustomer1.CreateNewCustomer())
customerList.Add(DemoCustomer1.CreateNewCustomer())
customerList.Add(DemoCustomer1.CreateNewCustomer())
' Bind the list to the BindingSource.
Me.customersBindingSource.DataSource = customerList
' Attach the BindingSource to the DataGridView.
Me.customersDataGridView.DataSource = Me.customersBindingSource
End Sub
' This event handler changes the value of the CompanyName
' property for the first item in the list.
Private Sub changeItemBtn_Click(ByVal sender As Object, ByVal e As EventArgs)
' Get a reference to the list from the BindingSource.
Dim customerList As BindingList(Of DemoCustomer1) =
CType(customersBindingSource.DataSource, BindingList(Of DemoCustomer1))
' Change the value of the CompanyName property for the
' first item in the list.
customerList(0).CustomerName = "Tailspin Toys"
customerList(0).PhoneNumber = "(708)555-0150"
End Sub
End Class
' This class implements a simple customer type
' that implements the IPropertyChange interface.
Public Class DemoCustomer1
Implements INotifyPropertyChanged
' These fields hold the values for the public properties.
Private idValue As Guid = Guid.NewGuid()
Private customerNameValue As String = String.Empty
Private phoneNumberValue As String = String.Empty
Public Event PropertyChanged As PropertyChangedEventHandler _
Implements INotifyPropertyChanged.PropertyChanged
' This method is called by the Set accessor of each property.
' The CallerMemberName attribute that is applied to the optional propertyName
' parameter causes the property name of the caller to be substituted as an argument.
Private Sub NotifyPropertyChanged(<CallerMemberName()> Optional ByVal propertyName As String = Nothing)
RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(propertyName))
End Sub
' The constructor is private to enforce the factory pattern.
Private Sub New()
customerNameValue = "Customer"
phoneNumberValue = "(312)555-0100"
End Sub
' This is the public factory method.
Public Shared Function CreateNewCustomer() As DemoCustomer1
Return New DemoCustomer1()
End Function
' This property represents an ID, suitable
' for use as a primary key in a database.
Public ReadOnly Property ID() As Guid
Get
Return Me.idValue
End Get
End Property
Public Property CustomerName() As String
Get
Return Me.customerNameValue
End Get
Set(ByVal value As String)
If Not (value = customerNameValue) Then
Me.customerNameValue = value
NotifyPropertyChanged()
End If
End Set
End Property
Public Property PhoneNumber() As String
Get
Return Me.phoneNumberValue
End Get
Set(ByVal value As String)
If Not (value = phoneNumberValue) Then
Me.phoneNumberValue = value
NotifyPropertyChanged()
End If
End Set
End Property
End Class
Synchronizowanie powiązań
Podczas implementacji powiązania danych w formularzach Systemu Windows wiele kontrolek jest powiązanych z tym samym źródłem danych. W niektórych przypadkach może być konieczne wykonanie dodatkowych kroków, aby upewnić się, że powiązane właściwości kontrolek pozostają zsynchronizowane ze sobą i ze źródłem danych. Te kroki są niezbędne w dwóch sytuacjach:
Jeśli źródło danych nie implementuje IBindingListelementu , a w związku z tym generuje ListChanged zdarzenia typu ItemChanged.
Jeśli źródło danych implementuje IEditableObjectelement .
W poprzednim przypadku można użyć elementu , BindingSource aby powiązać źródło danych z kontrolkami. W tym drugim przypadku należy użyć BindingSource
elementu i obsłużyć BindingComplete zdarzenie i wywołać EndCurrentEdit skojarzone BindingManagerBasepolecenie .
Aby uzyskać więcej informacji na temat implementowania tej koncepcji, zobacz stronę referencyjną interfejsu API BindingComplete.
Zobacz też
.NET Desktop feedback