This documentation is archived and is not being maintained.

Control.BindingContext Property

Gets or sets the BindingContext for the control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public function get BindingContext () : BindingContext 
public function set BindingContext (value : BindingContext)

Property Value

Type: System.Windows.Forms.BindingContext
A BindingContext for the control.



The BindingContext of a Control is used to return a single BindingManagerBase for all data-bound controls contained by the Control. The BindingManagerBase keeps all controls that are bound to the same data source synchronized. For example, setting the Position property of the BindingManagerBase specifies the item in the underlying list that all data-bound controls point to.

For more information about creating a new BindingContext and assigning it to the BindingContext property, see the BindingContext.

Notes to Inheritors:

When overriding the BindingContext property in a derived class, use the base class's BindingContext property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the get and set accessors of the BindingContext property; you can override only one if needed.

The following code example creates four Binding objects to bind five controls, a DateTimePicker and four TextBox controls, to several data sources. The BindingContext is then used to get the BindingManagerBase for each data source.

  protected function 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 string 
        "TableName.ColumnName". */
     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. */
     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. */
     var b : Binding = new Binding
        ("Text", ds, "customers.custToOrders.OrderAmount");

     // 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 function DecimalToCurrencyString(sender, cevent : ConvertEventArgs)
     /* 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". */

     // We can only convert to string type. 
     if(cevent.DesiredType != String.GetType()) return;

     cevent.Value = (Decimal(cevent.Value)).ToString("c");

  private function CurrencyStringToDecimal(sender, cevent : ConvertEventArgs)
     /* 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 != Decimal.GetType()) 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". */

  protected function button1_Click(sender, e : System.EventArgs)
     // Go to the previous item in the Customer list.
     bmCustomers.Position -= 1;

  protected function button2_Click(sender, e : System.EventArgs)
     // Go to the next item in the Customer list.
     bmCustomers.Position += 1;

  protected function button3_Click(sender, e : System.EventArgs)
     // Go to the previous item in the Orders list.

  protected function button4_Click(sender, e : System.EventArgs)
     // Go to the next item in the Orders list.

  // Create a DataSet with two tables and populate it.
  private function MakeDataSet()
     // Create a DataSet.
     ds = new DataSet("myDataSet");

     // Create two DataTables.
     var tCust : DataTable = new DataTable("Customers");
     var tOrders : DataTable= new DataTable("Orders");

     // Create two columns, and add them to the first table.
     var cCustID : DataColumn = new DataColumn("CustID", Int32);
     var cCustName : DataColumn = new DataColumn("CustName");

     // Create three columns, and add them to the second table.
     var cID : DataColumn  = 
        new DataColumn("CustID", Int32);
     var cOrderDate : DataColumn  = 
        new DataColumn("orderDate", DateTime);
     var cOrderAmount : DataColumn = 
        new DataColumn("OrderAmount", Decimal);

     // Add the tables to the DataSet.

     // Create a DataRelation, and add it to the DataSet.
     var dr : DataRelation = new DataRelation
     ("custToOrders", cCustID , cID);

     /* Populate the tables. For each customer and order, 
        create need two DataRow variables. */
     var newRow1 : DataRow;
     var newRow2 : DataRow;

     // Create three customers in the Customers Table.
     for(var i : int = 1; i < 4; i++)
        newRow1 = tCust.NewRow();
        newRow1["custID"] = i;
        // Add the row to the Customers table.
     // 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(var j : int = 1; j < 4; j++)
        for(var k : int = 1; k < 6; k++)
           newRow2 = tOrders.NewRow();
           newRow2["CustID"]= j;
           newRow2["orderDate"]= new DateTime(2001, j, k * 2);
           newRow2["OrderAmount"] = j * 10 + k  * .1;
           // Add the row to the Orders table.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0