Create a Windows Forms user control that supports complex data binding

Applies to: Visual Studio Visual Studio for Mac

When displaying data on forms in Windows applications, you can choose existing controls from the Toolbox. Or, you can author custom controls if your application requires functionality that is not available in the standard controls. This walkthrough shows how to create a control that implements the ComplexBindingPropertiesAttribute. Controls that implement the ComplexBindingPropertiesAttribute contain a DataSource and DataMember property that can be bound to data. Such controls are similar to a DataGridView or ListBox.

For more information on control authoring, see Developing Windows Forms controls at design time.

When authoring controls for use in data-binding scenarios you need to implement one of the following data-binding attributes:

This walkthrough creates a complex control that displays rows of data from a table. This example uses the Customers table from the Northwind sample database. The complex user control will display the customers table in a DataGridView in the custom control.

During this walkthrough, you'll learn how to:

• Add a new User Control to your project.

• Visually design the user control.

• Implement the ComplexBindingProperty attribute.

• Create a dataset with the Data Source Configuration Wizard.

• Set the Customers table in the Data Sources window to use the new complex control.

• Add the new control by dragging it from the Data Sources window onto Form1.

Prerequisites

This walkthrough uses SQL Server Express LocalDB and the Northwind sample database.

1. If you don't have SQL Server Express LocalDB, install it either from the SQL Server Express download page, or through the Visual Studio Installer. In the Visual Studio Installer, you can install SQL Server Express LocalDB as part of the Data storage and processing workload, or as an individual component.

2. Install the Northwind sample database by following these steps:

   1. In Visual Studio, open the SQL Server Object Explorer window. (SQL Server Object Explorer is installed as part of the Data storage and processing workload in the Visual Studio Installer.) Expand the SQL Server node. Right-click on your LocalDB instance and select New Query.

      A query editor window opens.

   2. Copy the Northwind Transact-SQL script to your clipboard. This T-SQL script creates the Northwind database from scratch and populates it with data.

   3. Paste the T-SQL script into the query editor, and then choose the Execute button.

      After a short time, the query finishes running and the Northwind database is created.

Create a Windows Forms app project

The first step is to create a Windows Forms App project for either C# or Visual Basic. Name the project ComplexControlWalkthrough.

Add a user control to the project

Because this walkthrough creates a complex data-bindable control from a User Control, add a User Control item to the project:

1. From the Project menu, choose Add User Control.

2. Type ComplexDataGridView in the Name area, and then click Add.

   The ComplexDataGridView control is added to Solution Explorer, and opens in the designer.

Design the ComplexDataGridView control

To add a DataGridView to the user control, drag a DataGridView from the Toolbox onto the user control's design surface.

Add the required data-binding attribute

For complex controls that support data binding, you can implement the ComplexBindingPropertiesAttribute:

1. Switch the ComplexDataGridView control to code view. (On the View menu, select Code.)

2. Replace the code in the ComplexDataGridView with the following:

   using System.Windows.Forms;
   
   namespace CS
   {
       [System.ComponentModel.ComplexBindingProperties("DataSource", "DataMember")]
       public partial class ComplexDataGridView : UserControl
       {
           public object DataSource
           {
               get{ return dataGridView1.DataSource; }
               set{ dataGridView1.DataSource = value; }
           }
   
           public string DataMember
           {
               get{ return dataGridView1.DataMember; }
               set{ dataGridView1.DataMember = value; }
           }
   
           public ComplexDataGridView()
           {
               InitializeComponent();
           }
       }
   }
   

   <System.ComponentModel.ComplexBindingProperties("DataSource", "DataMember")>
   Public Class ComplexDataGridView
   
       Public Property DataSource() As Object
           Get
               Return DataGridView1.DataSource
           End Get
           Set(ByVal value As Object)
               DataGridView1.DataSource = value
           End Set
       End Property
   
       Public Property DataMember() As String
           Get
               Return DataGridView1.DataMember
           End Get
           Set(ByVal value As String)
               DataGridView1.DataMember = value
           End Set
       End Property
   End Class
   

3. From the Build menu, choose Build Solution.

Create a data source from your database

Use the Data Source Configuration wizard to create a data source based on the Customers table in the Northwind sample database:

1. To open the Data Sources window, on the Data menu, click Show Data Sources.

2. In the Data Sources window, select Add New Data Source to start the Data Source Configuration wizard.

3. Select Database on the Choose a Data Source Type page, and then click Next.

4. On the Choose your Data Connection page do one of the following:

   • If a data connection to the Northwind sample database is available in the drop-down list, select it.

   • Select New Connection to launch the Add/Modify Connection dialog box.

5. If your database requires a password, select the option to include sensitive data, and then click Next.

6. On the Save connection string to the Application Configuration file page, click Next.

7. On the Choose your Database Objects page, expand the Tables node.

8. Select the Customers table, and then click Finish.

   The NorthwindDataSet is added to your project, and the Customers table appears in the Data Sources window.

Set the Customers table to use the ComplexDataGridView control

Within the Data Sources window, you can set the control to be created prior to dragging items onto your form:

1. Open Form1 in the designer.

2. Expand the Customers node in the Data Sources window.

3. Click the drop-down arrow on the Customers node, and choose Customize.

4. Select the ComplexDataGridView from the list of Associated Controls in the Data UI Customization Options dialog box.

5. Click the drop-down arrow on the Customers table, and choose ComplexDataGridView from the control list.

Add controls to the form

You can create the data-bound controls by dragging items from the Data Sources window onto your form. Drag the main Customers node from the Data Sources window onto the form. Verify that the ComplexDataGridView control is used to display the table's data.

Run the application

Press F5 to run the application.

Next steps

Depending on your application requirements, there are several steps you may want to perform after creating a control that supports databinding. Some typical next steps include:

• Placing your custom controls in a control library so you can reuse them in other applications.

• Creating controls that support lookup scenarios. For more information, see Create a Windows Forms user control that supports lookup data binding.

See also

• Bind Windows Forms controls to data in Visual Studio
• Set the control to be created when dragging from the Data Sources window
• Windows Forms Controls