Прочитать на английском

Поделиться через

Binding Класс

  • Ссылка

Определение

Пространство имен:
System.Windows.Forms
Сборка:
System.Windows.Forms.dll

Представляет простую привязку между значением свойства объекта и значением свойства элемента управления.

[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.ListBindingConverter))]
public class Binding
Наследование
Object
Binding
Атрибуты
TypeConverterAttribute

Примеры

В следующем примере кода создается форма Windows Forms с несколькими элементами управления, демонстрирующими простую привязку данных. В этом примере создается DataSet с двумя таблицами с именами Customers и Orders, а также DataRelation с именем custToOrders. Четыре элемента управления (и DateTimePicker три TextBox элемента управления) являются данными, привязанными к столбцам в таблицах. Для каждого элемента управления в примере создается и добавляется к элементу Binding управления с помощью DataBindings свойства . В этом примере возвращается для каждой BindingManagerBase таблицы через .BindingContext Четыре Button элемента управления увеличивают или уменьшают Position свойство в объектах BindingManagerBase .

using System;
using System.Data;
using System.Drawing;
using System.Globalization;
using System.Windows.Forms;

public class Form1 : System.Windows.Forms.Form
{
   private System.ComponentModel.Container components;
   private Button button1;
   private Button button2;
   private Button button3;
   private Button button4;
   private TextBox text1;
   private TextBox text2;
   private TextBox text3;

   private BindingManagerBase bmCustomers;
   private BindingManagerBase bmOrders;
   private DataSet ds;
   private DateTimePicker DateTimePicker1;

   public Form1()
   {
      // Required for Windows Form Designer support.
      InitializeComponent();
      // Call SetUp to bind the controls.
      SetUp();
   }
 
   private void InitializeComponent()
   {
      // Create the form and its controls.
      this.components = new System.ComponentModel.Container();
      this.button1 = new System.Windows.Forms.Button();
      this.button2 = new System.Windows.Forms.Button();
      this.button3 = new System.Windows.Forms.Button();
      this.button4 = new System.Windows.Forms.Button();
      
      this.text1= new System.Windows.Forms.TextBox();
      this.text2= new System.Windows.Forms.TextBox();
      this.text3= new System.Windows.Forms.TextBox();
      
      this.DateTimePicker1 = new DateTimePicker();
      
      this.Text = "Binding Sample";
      this.ClientSize = new System.Drawing.Size(450, 200);
      
      button1.Location = new System.Drawing.Point(24, 16);
      button1.Size = new System.Drawing.Size(64, 24);
      button1.Text = "<";
      button1.Click+=new System.EventHandler(button1_Click);

      button2.Location = new System.Drawing.Point(90, 16);
      button2.Size = new System.Drawing.Size(64, 24);
      button2.Text = ">";
      button2.Click+=new System.EventHandler(button2_Click);

      button3.Location = new System.Drawing.Point(90, 100);
      button3.Size = new System.Drawing.Size(64, 24);
      button3.Text = "<";
      button3.Click+=new System.EventHandler(button3_Click);

      button4.Location = new System.Drawing.Point(150, 100);
      button4.Size = new System.Drawing.Size(64, 24);
      button4.Text = ">";
      button4.Click+=new System.EventHandler(button4_Click);

      text1.Location = new System.Drawing.Point(24, 50);
      text1.Size = new System.Drawing.Size(150, 24);

      text2.Location = new System.Drawing.Point(190, 50);
      text2.Size = new System.Drawing.Size(150, 24);

      text3.Location = new System.Drawing.Point(290, 150);
      text3.Size = new System.Drawing.Size(150, 24);
      
      DateTimePicker1.Location = new System.Drawing.Point(90, 150);
      DateTimePicker1.Size = new System.Drawing.Size(200, 800);
      
      this.Controls.Add(button1);
      this.Controls.Add(button2);
      this.Controls.Add(button3);
      this.Controls.Add(button4);
      this.Controls.Add(text1);
      this.Controls.Add(text2);
      this.Controls.Add(text3);
      this.Controls.Add(DateTimePicker1);
   }

   protected override void Dispose( bool disposing ){
      if( disposing ){
         if (components != null){
            components.Dispose();}
      }
      base.Dispose( disposing );
   }
   public static void Main()
   {
      Application.Run(new Form1());
   }
   
   private void SetUp()
   {
      // Create a DataSet with two tables and one relation.
      MakeDataSet();
      BindControls();
   }

   protected void BindControls()
   {
      /* Create two Binding objects for the first two TextBox 
         controls. The data-bound property for both controls 
         is the Text property. The data source is a DataSet 
         (ds). The data member is the  
         "TableName.ColumnName" string. */
      text1.DataBindings.Add(new Binding
      ("Text", ds, "customers.custName"));
      text2.DataBindings.Add(new Binding
      ("Text", ds, "customers.custID"));
      
      /* Bind the DateTimePicker control by adding a new Binding. 
         The data member of the DateTimePicker is a 
         TableName.RelationName.ColumnName string. */
      DateTimePicker1.DataBindings.Add(new 
      Binding("Value", ds, "customers.CustToOrders.OrderDate"));

      /* Add event delegates for the Parse and Format events to a 
         new Binding object, and add the object to the third 
         TextBox control's BindingsCollection. The delegates 
         must be added before adding the Binding to the 
         collection; otherwise, no formatting occurs until 
         the Current object of the BindingManagerBase for 
         the data source changes. */
      Binding b = new Binding
         ("Text", ds, "customers.custToOrders.OrderAmount");
      b.Parse+=new ConvertEventHandler(CurrencyStringToDecimal);
      b.Format+=new ConvertEventHandler(DecimalToCurrencyString);
      text3.DataBindings.Add(b);

      // Get the BindingManagerBase for the Customers table. 
      bmCustomers = this.BindingContext [ds, "Customers"];

      /* Get the BindingManagerBase for the Orders table using the 
         RelationName. */ 
      bmOrders = this.BindingContext[ds, "customers.CustToOrders"];
   }

   private void DecimalToCurrencyString(object sender, ConvertEventArgs cevent)
   {
      /* This method is the Format event handler. Whenever the 
         control displays a new value, the value is converted from 
         its native Decimal type to a string. The ToString method 
         then formats the value as a Currency, by using the 
         formatting character "c". */

      // The application can only convert to string type. 
      if(cevent.DesiredType != typeof(string)) return;

      cevent.Value = ((decimal) cevent.Value).ToString("c");
   }

   private void CurrencyStringToDecimal(object sender, ConvertEventArgs cevent)
   {   
      /* This method is the Parse event handler. The Parse event 
         occurs whenever the displayed value changes. The static 
         ToDecimal method of the Convert class converts the 
         value back to its native Decimal type. */

      // Can only convert to decimal type.
      if(cevent.DesiredType != typeof(decimal)) return;

      cevent.Value = Decimal.Parse(cevent.Value.ToString(),
        NumberStyles.Currency, null);

      /* To see that no precision is lost, print the unformatted 
         value. For example, changing a value to "10.0001" 
         causes the control to display "10.00", but the 
         unformatted value remains "10.0001". */
      Console.WriteLine(cevent.Value);
   }

   private void button1_Click(object sender, System.EventArgs e)
   {
      // Go to the previous item in the Customer list.
      bmCustomers.Position -= 1;
   }

   private void button2_Click(object sender, System.EventArgs e)
   {
      // Go to the next item in the Customer list.
      bmCustomers.Position += 1;
   }
    
   private void button3_Click(object sender, System.EventArgs e)
   {
      // Go to the previous item in the Orders list.
      bmOrders.Position-=1;
   }

   private void button4_Click(object sender, System.EventArgs e)
   {
      // Go to the next item in the Orders list.
      bmOrders.Position+=1;
   }

   // Create a DataSet with two tables and populate it.
   private void MakeDataSet()
   {
      // Create a DataSet.
      ds = new DataSet("myDataSet");
      
      // Create two DataTables.
      DataTable tCust = new DataTable("Customers");
      DataTable tOrders = new DataTable("Orders");

      // Create two columns, and add them to the first table.
      DataColumn cCustID = new DataColumn("CustID", typeof(int));
      DataColumn cCustName = new DataColumn("CustName");
      tCust.Columns.Add(cCustID);
      tCust.Columns.Add(cCustName);

      // Create three columns, and add them to the second table.
      DataColumn cID = 
         new DataColumn("CustID", typeof(int));
      DataColumn cOrderDate = 
         new DataColumn("orderDate",typeof(DateTime));
      DataColumn cOrderAmount = 
         new DataColumn("OrderAmount", typeof(decimal));
      tOrders.Columns.Add(cOrderAmount);
      tOrders.Columns.Add(cID);
      tOrders.Columns.Add(cOrderDate);

      // Add the tables to the DataSet.
      ds.Tables.Add(tCust);
      ds.Tables.Add(tOrders);

      // Create a DataRelation, and add it to the DataSet.
      DataRelation dr = new DataRelation
      ("custToOrders", cCustID , cID);
      ds.Relations.Add(dr);
   
      /* Populate the tables. For each customer and order, 
         create two DataRow variables. */
      DataRow newRow1;
      DataRow newRow2;

      // Create three customers in the Customers Table.
      for(int i = 1; i < 4; i++)
      {
         newRow1 = tCust.NewRow();
         newRow1["custID"] = i;
         // Add the row to the Customers table.
         tCust.Rows.Add(newRow1);
      }
      // Give each customer a distinct name.
      tCust.Rows[0]["custName"] = "Alpha";
      tCust.Rows[1]["custName"] = "Beta";
      tCust.Rows[2]["custName"] = "Omega";
      
      // For each customer, create five rows in the Orders table.
      for(int i = 1; i < 4; i++)
      {
         for(int j = 1; j < 6; j++)
         {
            newRow2 = tOrders.NewRow();
            newRow2["CustID"]= i;
            newRow2["orderDate"]= new DateTime(2001, i, j * 2);
            newRow2["OrderAmount"] = i * 10 + j  * .1;
            // Add the row to the Orders table.
            tOrders.Rows.Add(newRow2);
         }
      }
   }
 }

Комментарии

Используйте класс для Binding создания и поддержания простой привязки между свойством элемента управления и свойством объекта или свойством текущего объекта в списке объектов .

В качестве примера первого случая можно привязать Text свойство TextBox элемента управления к свойству FirstNameCustomer объекта . В качестве примера второго случая можно привязать Text свойство TextBox элемента управления к свойству FirstName объекта , DataTable который содержит клиентов.

Класс Binding также позволяет форматировать значения для отображения через Format событие и получать отформатированные значения с помощью Parse события .

При создании экземпляра Binding с Binding помощью конструктора необходимо указать три элемента:

  • Имя свойства элемента управления для привязки.

  • Источник данных.

  • Путь навигации, который разрешается в список или свойство в источнике данных. Путь навигации также используется для создания свойства объекта BindingMemberInfo .

Сначала необходимо указать имя свойства элемента управления, к которому требуется привязать данные. Например, чтобы отобразить данные в элементе TextBoxText управления, укажите свойство .

Во-вторых, в качестве источника данных можно указать экземпляр любого из классов в следующей таблице.

Описание Пример в C#
Любой класс, реализующий IBindingList или ITypedList. К ним относятся: DataSet, DataTable, DataViewили DataViewManager. DataSet ds = new DataSet("myDataSet");
Любой класс, реализующий IList для создания индексированных коллекций объектов . Коллекция должна быть создана и заполнена Bindingперед созданием . Все объекты в списке должны иметь один и тот же тип; в противном случае будет создано исключение. ArrayList ar1 = new ArrayList; Customer1 cust1 = new Customer("Louis"); ar1.Add(cust1);
Строго типизированные строго типизированные IList объекты Customer [] custList = new Customer[3];

В-третьих, необходимо указать путь навигации, который может быть пустой строкой (""), именем одного свойства или иерархией имен с разделителями-точками. Если для пути навигации задана пустая строка, ToString метод будет вызываться для базового объекта источника данных.

Если источником данных является DataTable, который может содержать несколько DataColumn объектов, для разрешения в определенный столбец необходимо использовать путь навигации.

Примечание

Если источником данных является DataSet, DataViewManagerили DataTable, фактически выполняется привязка DataViewк . Следовательно, привязанные строки фактически DataRowView являются объектами.

Путь навигации с разделителями-точками необходим, если для источника данных задан объект , содержащий несколько DataTable объектов (например, DataSet или DataViewManager). Вы также можете использовать путь навигации с разделителями-точками при привязке к объекту, свойства которого возвращают ссылки на другие объекты (например, класс со свойствами, возвращающими другие объекты класса). Например, следующие пути навигации описывают допустимые поля данных:

  • "Size.Height"

  • "Suppliers.CompanyName"

  • Regions.regionsToCustomers.CustomerFirstName

  • Regions.regionsToCustomers.customersToOrders.ordersToDetails.Quantity

Каждый элемент пути может возвращать либо свойство, разрешающееся в одно значение (например, целое число), либо список значений (например, массив строк). Хотя каждый элемент в пути может быть списком или свойством, последний член должен разрешаться в свойство . Каждый элемент строится на предыдущем элементе: "Size.Height" разрешается в Height свойство для текущего Size; "Regions.regionsToCustomers.CustomerFirstName" разрешается в имя текущего клиента, где клиент является одним из клиентов в текущем регионе.

Возвращает DataRelation список значений путем связывания одного DataTable со вторым DataTable в DataSet. DataSet Если содержит DataRelation объекты , можно указать элемент данных как TableName , за которым следует RelationName, а затем ColumnName. Например, если DataTable с именем "Поставщики" содержится DataRelation с именем "suppliers2products", то элементом данных может быть "Suppliers.suppliers2products.ProductName".

Источник данных может состоять из набора связанных классов. Например, представьте себе набор классов, которые каталогии солнечных систем. Класс с именем System содержит свойство с именем Stars , которое возвращает коллекцию Star объектов . Каждый Star объект имеет Name свойства и Mass , а также Planets свойство, возвращающее коллекцию Planet объектов . В этой системе каждая планета также имеет Mass свойства и Name . Каждый Planet объект также имеет Moons свойство , которое возвращает коллекцию Moon объектов , каждый из которых также имеет Name свойства и Mass . При указании объекта в System качестве источника данных можно указать любой из следующих элементов данных:

  • "Stars.Name"

  • "Stars.Mass"

  • "Stars.Planets.Name"

  • "Stars.Planets.Mass"

  • "Stars.Planets.Moons.Name"

  • "Stars.Planets.Moons.Mass"

Элементы управления, которые могут быть просто привязаны, имеют коллекцию Binding объектов в ControlBindingsCollection, доступ к которым можно получить через свойство элемента управления DataBindings . Binding Добавляется в коллекцию путем вызова Add метода , тем самым привязывая свойство элемента управления к свойству объекта (или свойству текущего объекта в списке).

Можно выполнить простую привязку к любому объекту, который является производным System.Windows.Forms.Control от класса , например к следующим элементам управления Windows:

Примечание

Просто привязано SelectedValueComboBoxтолько свойство элемента управления , CheckedListBoxи ListBox .

Класс BindingManagerBase является абстрактным классом, который управляет всеми объектами Binding для конкретного источника данных и элемента данных. Классы, производные от BindingManagerBase , являются классами CurrencyManagerPropertyManager и . Binding Способ управления зависит от того, является ли Binding элемент привязкой списка или привязкой свойств. Например, если это привязка списка, можно использовать BindingManagerBase для указания Position в списке; Positionтаким образом, определяет, какой элемент (из всех элементов списка) фактически привязан к элементу управления. Чтобы вернуть соответствующий BindingManagerBaseобъект , используйте BindingContext.

Чтобы добавить новую строку в набор элементов управления, привязанных к одному и тому же DataSource, используйте AddNew метод BindingManagerBase класса . Item[] Используйте свойство класса , BindingContext чтобы вернуть соответствующий CurrencyManagerобъект . Чтобы избежать добавления новой строки, используйте CancelCurrentEdit метод .

Конструкторы

Binding(String, Object, String)

Инициализирует новый экземпляр класса Binding, выполняющего простую привязку указанного свойства элемента управления к указанным данным-члену для указанного источника данных.
Binding(String, Object, String, Boolean)

Инициализирует новый экземпляр класса Binding, выполняющего простую привязку указанного свойства элемента управления к указанным данным для указанного источника данных и при необходимости включает применение форматирования.
Binding(String, Object, String, Boolean, DataSourceUpdateMode)

Инициализирует новый экземпляр класса Binding, выполняющего привязку указанного свойства элемента управления к указанным данным заданного источника данных. При необходимости включает форматирование и выполняет распространение значений в источник данных на основе заданного значения параметра обновления.
Binding(String, Object, String, Boolean, DataSourceUpdateMode, Object)

Инициализирует новый экземпляр класса Binding, выполняющего привязку указанного свойства элемента управления к указанным данным заданного источника данных. При необходимости включает форматирование, распространяет значения в источник данных на основе заданного значения параметра обновления, а также присваивает этому свойству указанное значение при возвращении значения DBNull из источника данных.
Binding(String, Object, String, Boolean, DataSourceUpdateMode, Object, String)

Инициализирует новый экземпляр класса Binding, выполняющего привязку указанного свойства элемента управления к указанным данным заданного источника данных. При необходимости включает форматирование с заданной строкой формата, распространяет значения в источник данных на основе заданного значения параметра обновления, а также присваивает этому свойству указанное значение при возвращении значения DBNull из источника данных.
Binding(String, Object, String, Boolean, DataSourceUpdateMode, Object, String, IFormatProvider)

Инициализирует новый экземпляр класса Binding, выполняющего привязку указанного свойства элемента управления к указанным данным заданного источника данных. При необходимости включает форматирование с заданной строкой форматирования; распространяет значения в источник данных на основе заданного параметра обновления; включает форматирование с заданной строкой форматирования; присваивает свойству заданное значение при возвращении значения DBNull из источника данных; указывает заданный поставщик формата.

Свойства

BindableComponent

Возвращает элемент управления, которому сопоставлен объект Binding.
BindingManagerBase

Получает объект BindingManagerBase для данного элемента Binding.
BindingMemberInfo

Возвращает объект, содержащий сведения о данной привязке, основанные на параметре dataMember в конструкторе Binding.
Control

Возвращает элемент управления, которому принадлежит данная привязка.
ControlUpdateMode

Возвращает или задает момент распространения изменений, внесенных в источник данных, в свойство привязанного элемента управления.
DataSource

Возвращает источник данных для этой привязки.
DataSourceNullValue

Возвращает или задает значение, которое должно храниться в источнике данных в том случае, если элемент управления имеет значение null или является пустым.
DataSourceUpdateMode

Возвращает или задает значение момента распространения изменений, внесенных в свойство привязанного элемента управления, в источник данных.
FormatInfo

Получает или задает IFormatProvider, предоставляющий пользовательское поведение форматирования.
FormatString

Возвращает или задает символы описателя формата, который определяет способ отображения значения.
FormattingEnabled

Возвращает или задает значение, указывающее, должно ли применяться преобразование типов и форматирование к данным свойствам элемента управления.
IsBinding

Возвращает значение, указывающее, активна ли привязка.
NullValue

Возвращает или задает объект Object, который должен быть установлен как свойство элемента управления, если источник данных содержит значение DBNull.
PropertyName

Возвращает имя свойства с привязкой к данным элемента управления.

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.

(Унаследовано от Object)
OnBindingComplete(BindingCompleteEventArgs)

Вызывает событие BindingComplete.
OnFormat(ConvertEventArgs)

Вызывает событие Format.
OnParse(ConvertEventArgs)

Вызывает событие Parse.
ReadValue()

Присваивает свойству элемента управления значение, считанное из источника данных.
ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)
WriteValue()

Считывает текущее значение из свойства элемента управления и записывает его в источник данных.

События

BindingComplete

Возникает, когда свойство FormattingEnabled получает значение true и завершается операция привязки, например при передаче данных из элемента управления в источник данных или наоборот.
Format

Происходит, если свойство элемента управления привязано к значению данных.
Parse

Происходит при изменении значения элемента управления с привязкой к данным.

Применяется к

Продукт Версии
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

См. также раздел