Walkthrough: Creating a User Control that Supports Simple Data Binding

Article
11/16/2012

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 DefaultBindingPropertyAttribute. Controls that implement the DefaultBindingPropertyAttribute can contain one property that can be bound to data. Such controls are similar to a TextBox or CheckBox.

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:

Databinding Attribute Usage
Implement the DefaultBindingPropertyAttribute on simple controls, like a TextBox, that display a single column (or property) of data. (This process is described in this walkthrough page.)
Implement the ComplexBindingPropertiesAttribute on controls, like a DataGridView, that display lists (or tables) of data. For more information, see Walkthrough: Creating a User Control that Supports Complex Data Binding.
Implement the LookupBindingPropertiesAttribute on controls, like a ComboBox, that display lists (or tables) of data but also need to present a single column or property. For more information, see Walkthrough: Creating a User Control that Supports Lookup Databinding.

This walkthrough creates a simple control that displays data from a single column in a table. This example uses the Phone column of the Customers table from the Northwind sample database. The simple user control will display customer's phone numbers in a standard phone-number format by using a MaskedTextBox and setting the mask to a phone number.

During this walkthrough, you will learn how to:

Create a new Windows Application.
Add a new User Control to your project.
Visually design the user control.
Implement the DefaultBindingProperty attribute.
Create a dataset with the Data Source Configuration Wizard.
Set the Phone column in the Data Sources window to use the new control.
Create a form to display data in the new control.

Prerequisites

In order to complete this walkthrough, you will need:

Access to the Northwind sample database. For more information, see How to: Install Sample Databases.

Creating a Windows Application

The first step is to create a Windows Application.

To create the new Windows project

In Visual Studio, from the File menu, create a new Project.
Name the project SimpleControlWalkthrough.
Select Windows Application and click OK. For more information, see Creating Windows-Based Applications.

The SimpleControlWalkthrough project is created and added to Solution Explorer.

Adding a User Control to the Project

This walkthrough creates a simple data-bindable control from a User Control, so add a User Control item to the SimpleControlWalkthrough project.

To add a user control to the project

From the Project menu, choose Add User Control.
Type PhoneNumberBox in the Name area, and click Add.

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

Designing the PhoneNumberBox Control

This walkthrough expands upon the existing MaskedTextBox to create the PhoneNumberBox control.

To design the PhoneNumberBox control

Drag a MaskedTextBox from the Toolbox onto the user control's design surface.
Select the smart tag on the MaskedTextBox you just dragged and choose Set Mask.
Select Phone number in the Input Mask dialog box and click OK to set the mask.

Adding the Required Data-binding Attribute

For simple controls that support databinding, implement the DefaultBindingPropertyAttribute.

To implement the DefaultBindingProperty attribute

Switch the PhoneNumberBox control to code view. (On the View menu, choose Code.)

Replace the code in the PhoneNumberBox with the following:

<System.ComponentModel.DefaultBindingProperty("PhoneNumber")> _
Public Class PhoneNumberBox

    Public Property PhoneNumber() As String 
        Get 
            Return MaskedTextBox1.Text
        End Get 
        Set(ByVal value As String)
            MaskedTextBox1.Text = value
        End Set 
    End Property 
End Class

using System.Windows.Forms;

namespace CS
{
    [System.ComponentModel.DefaultBindingProperty("PhoneNumber")]
    public partial class PhoneNumberBox : UserControl
    {
        public string PhoneNumber
        {
            get{ return maskedTextBox1.Text; }
            set{ maskedTextBox1.Text = value; }
        }

        public PhoneNumberBox()
        {
            InitializeComponent();
        }
    }
}

From the Build menu, choose Build Solution.

Creating a Data Source from Your Database

This step uses the Data Source Configuration Wizard to create a data source based on the Customers table in the Northwind sample database. You must have access to the Northwind sample database to create the connection. For information on setting up the Northwind sample database, see How to: Install Sample Databases.

To create the data source

On the Data menu, click Show Data Sources.
In the Data Sources window, select Add New Data Source to start the Data Source Configuration Wizard.
Select Database on the Choose a Data Source Type page, and then click Next.
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.
  
  Or
- Select New Connection to launch the Add/Modify Connection dialog box. For more information, see Add/Modify Connection Dialog Box (General).
If your database requires a password, select the option to include sensitive data, and then click Next.
Click Next on the Save connection string to the Application Configuration file page.
Expand the Tables node on the Choose your Database Objects page.
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.

Setting the Phone Column To Use the PhoneNumberBox Control

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

To set the phone column to bind to the PhoneNumberBox control

Open Form1 in the designer.
Expand the Customers node in the Data Sources window.
Click the drop-down arrow on the Customers node and choose Details from the control list.
Click the drop-down arrow on the Phone column and choose Customize.
Select the PhoneNumberBox from the list of Associated Controls in the Data UI Customization Options dialog box.
Click the drop-down arrow on the Phone column and choose PhoneNumberBox.

Adding Controls to the Form

You can create the data-bound controls by dragging items from the Data Sources window onto the form.

To create data-bound controls on the form

Drag the main Customers node from the Data Sources window onto the form and verify that the PhoneNumberBox control is used to display the data in the Phone column.

Data-bound controls with descriptive labels appear on the form, along with a tool strip (BindingNavigator) for navigating records. A NorthwindDataSet, CustomersTableAdapter, BindingSource, and BindingNavigator appear in the component tray.

Running the Application

To 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 data binding. Some typical next steps include:

Placing your custom controls in a control library so you can reuse them in other applications. For more information, see Windows Control Library Template.
Creating controls that support more complex data-binding scenarios. For more information, see Walkthrough: Creating a User Control that Supports Complex Data Binding and Walkthrough: Creating a User Control that Supports Lookup Databinding.

Share via