Comment : lier des données au contrôle MaskedTextBox

Article
08/21/2008

Mise à jour : novembre 2007

Vous pouvez lier des données à un contrôle MaskedTextBox comme à n'importe quel autre contrôle Windows Forms. Toutefois, si le format de vos données dans la base de données ne correspond pas au format attendu par votre définition de masque, vous devrez reformater les données. La procédure suivante montre comment procéder à l'aide des événements Format et Parse de la classe Binding pour afficher des champs de base de données de numéro de téléphone et de numéro de poste distincts comme un seul champ modifiable.

La procédure suivante nécessite que vous ayez accès à une base de données SQL Server avec l'exemple de base de données Northwind installé.

Pour lier des données à un contrôle MaskedTextBox

Créez un projet Windows Forms.
Faites glisser deux contrôles TextBox sur votre formulaire ; nommez-les FirstName et LastName.
Faites glisser un contrôle MaskedTextBox sur votre formulaire ; nommez-le PhoneMask.
Attribuez à la propriété Mask de PhoneMask la valeur (000) 000-0000 x9999.
Ajoutez les importations d'espaces de noms suivantes dans le formulaire :
```
using System.Data.SqlClient;
```
```
Imports System.Data.SqlClient
```

Cliquez avec le bouton droit sur le formulaire et choisissez Afficher le code. Placez ce code n'importe où dans votre classe Form.

Binding currentBinding, phoneBinding;
DataSet employeesTable = new DataSet();
SqlConnection sc;
SqlDataAdapter dataConnect;

private void Form1_Load(object sender, EventArgs e)
{
    DoMaskBinding();
}

private void DoMaskBinding()
{
    try
    {
        sc = new SqlConnection("Data Source=CLIENTUE;Initial Catalog=NORTHWIND;Integrated Security=SSPI");
        sc.Open();
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
        return;
    }

    dataConnect = new SqlDataAdapter("SELECT * FROM Employees", sc);
    dataConnect.Fill(employeesTable, "Employees");

    // Now bind MaskedTextBox to appropriate field. Note that we must create the Binding objects
    // before adding them to the control - otherwise, we won't get a Format event on the 
    // initial load. 
    try
    {
        currentBinding = new Binding("Text", employeesTable, "Employees.FirstName");
        firstName.DataBindings.Add(currentBinding);

        currentBinding = new Binding("Text", employeesTable, "Employees.LastName");
        lastName.DataBindings.Add(currentBinding);

        phoneBinding =new Binding("Text", employeesTable, "Employees.HomePhone");
        // We must add the event handlers before we bind, or the Format event will not get called
        // for the first record.
        phoneBinding.Format += new ConvertEventHandler(phoneBinding_Format);
        phoneBinding.Parse += new ConvertEventHandler(phoneBinding_Parse);
        phoneMask.DataBindings.Add(phoneBinding);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
        return;
    }
}

Dim WithEvents CurrentBinding, PhoneBinding As Binding
Dim EmployeesTable As New DataSet()
Dim sc As SqlConnection
Dim DataConnect As SqlDataAdapter

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    DoMaskedBinding()
End Sub

Private Sub DoMaskedBinding()
    Try
        sc = New SqlConnection("Data Source=SERVERNAME;Initial Catalog=NORTHWIND;Integrated Security=SSPI")
        sc.Open()
    Catch ex As Exception
        MessageBox.Show(ex.Message)
        Exit Sub
    End Try

    DataConnect = New SqlDataAdapter("SELECT * FROM Employees", sc)
    DataConnect.Fill(EmployeesTable, "Employees")

    ' Now bind MaskedTextBox to appropriate field. Note that we must create the Binding objects
    ' before adding them to the control - otherwise, we won't get a Format event on the 
    ' initial load.
    Try
        CurrentBinding = New Binding("Text", EmployeesTable, "Employees.FirstName")
        firstName.DataBindings.Add(CurrentBinding)
        CurrentBinding = New Binding("Text", EmployeesTable, "Employees.LastName")
        lastName.DataBindings.Add(CurrentBinding)
        PhoneBinding = New Binding("Text", EmployeesTable, "Employees.HomePhone")
        PhoneMask.DataBindings.Add(PhoneBinding)
    Catch ex As Exception
        MessageBox.Show(ex.Message)
        Application.Exit()
    End Try
End Sub

Ajoutez les gestionnaires d'événements pour les événements Format et Parse afin de combiner et séparer les champs PhoneNumber et Extension du DataSet lié.

private void phoneBinding_Format(Object sender, ConvertEventArgs e)
{
    String ext;

    DataRowView currentRow = (DataRowView)BindingContext[employeesTable, "Employees"].Current;
    if (currentRow["Extension"] == null) 
    {
        ext = "";
    } else 
    {
        ext = currentRow["Extension"].ToString();
    }

    e.Value = e.Value.ToString().Trim() + " x" + ext;
}

private void phoneBinding_Parse(Object sender, ConvertEventArgs e)
{
    String phoneNumberAndExt = e.Value.ToString();

    int extIndex = phoneNumberAndExt.IndexOf("x");
    String ext = phoneNumberAndExt.Substring(extIndex).Trim();
    String phoneNumber = phoneNumberAndExt.Substring(0, extIndex).Trim();

    //Get the current binding object, and set the new extension manually. 
    DataRowView currentRow = (DataRowView)BindingContext[employeesTable, "Employees"].Current;
    // Remove the "x" from the extension.
    currentRow["Extension"] = ext.Substring(1);

    //Return the phone number.
    e.Value = phoneNumber;
}

Private Sub PhoneBinding_Format(ByVal sender As Object, ByVal e As ConvertEventArgs) Handles PhoneBinding.Format
    Dim Ext As String

    Dim CurrentRow As DataRowView = CType(Me.BindingContext(EmployeesTable, "Employees").Current, DataRowView)
    If (CurrentRow("Extension") Is Nothing) Then
        Ext = ""
    Else
        Ext = CurrentRow("Extension").ToString()
    End If

    e.Value = e.Value.ToString().Trim() & " x" & Ext
End Sub

Private Sub PhoneBinding_Parse(ByVal sender As Object, ByVal e As ConvertEventArgs) Handles PhoneBinding.Parse
    Dim PhoneNumberAndExt As String = e.Value.ToString()

    Dim ExtIndex As Integer = PhoneNumberAndExt.IndexOf("x")
    Dim Ext As String = PhoneNumberAndExt.Substring(ExtIndex).Trim()
    Dim PhoneNumber As String = PhoneNumberAndExt.Substring(0, ExtIndex).Trim()

    ' Get the current binding object, and set the new extension manually. 
    Dim CurrentRow As DataRowView = CType(Me.BindingContext(EmployeesTable, "Employees").Current, DataRowView)
    ' Remove the "x" from the extension.
    CurrentRow("Extension") = CObj(Ext.Substring(1))

    ' Return the phone number.
    e.Value = PhoneNumber
End Sub

Ajoutez deux contrôles Button au formulaire. Nommez-les previousButton et nextButton. Double-cliquez sur chaque bouton pour ajouter un gestionnaire d'événements Click et remplissez les gestionnaires d'événements comme dans l'exemple de code suivant.

private void previousButton_Click(object sender, EventArgs e)
{
    BindingContext[employeesTable, "Employees"].Position = BindingContext[employeesTable, "Employees"].Position - 1;
}

private void nextButton_Click(object sender, EventArgs e)
{
    BindingContext[employeesTable, "Employees"].Position = BindingContext[employeesTable, "Employees"].Position + 1;
}

Private Sub PreviousButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles PreviousButton.Click
    Me.BindingContext(EmployeesTable, "Employees").Position = Me.BindingContext(EmployeesTable, "Employees").Position - 1
End Sub

Private Sub NextButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles NextButton.Click
    Me.BindingContext(EmployeesTable, "Employees").Position = Me.BindingContext(EmployeesTable, "Employees").Position + 1
End Sub

Exécutez l'exemple. Modifiez les données et utilisez les boutons Précédent et Suivant pour vérifier que les données sont persistantes dans le DataSet.

Exemple

L'exemple de code suivant est la liste de code complète qui résulte de l'exécution de la procédure précédente.

Imports System.Data.SqlClient

Public Class Form1
    Dim WithEvents CurrentBinding, PhoneBinding As Binding
    Dim EmployeesTable As New DataSet()
    Dim sc As SqlConnection
    Dim DataConnect As SqlDataAdapter

    Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
        DoMaskedBinding()
    End Sub

    Private Sub DoMaskedBinding()
        Try
            sc = New SqlConnection("Data Source=localhost;Initial Catalog=NORTHWIND;Integrated Security=SSPI")
            sc.Open()
        Catch ex As Exception
            MessageBox.Show(ex.Message)
            Application.Exit()
        End Try

        DataConnect = New SqlDataAdapter("SELECT * FROM Employees", sc)
        DataConnect.Fill(EmployeesTable, "Employees")

        ' Now bind MaskedTextBox to appropriate field. Note that we must create the Binding objects
        ' before adding them to the control - otherwise, we won't get a Format event on the 
        ' initial load. 
        Try
            CurrentBinding = New Binding("Text", EmployeesTable, "Employees.FirstName")
            firstName.DataBindings.Add(CurrentBinding)
            CurrentBinding = New Binding("Text", EmployeesTable, "Employees.LastName")
            lastName.DataBindings.Add(CurrentBinding)
            PhoneBinding = New Binding("Text", EmployeesTable, "Employees.HomePhone")
            PhoneMask.DataBindings.Add(PhoneBinding)
        Catch ex As Exception
            MessageBox.Show(ex.Message)
            Application.Exit()
        End Try
    End Sub

    Private Sub PhoneBinding_Format(ByVal sender As Object, ByVal e As ConvertEventArgs) Handles PhoneBinding.Format
        Dim Ext As String

        Dim CurrentRow As DataRowView = CType(Me.BindingContext(EmployeesTable, "Employees").Current, DataRowView)
        If (CurrentRow("Extension") Is Nothing) Then
            Ext = ""
        Else
            Ext = CurrentRow("Extension").ToString()
        End If

        e.Value = e.Value.ToString().Trim() & " x" & Ext
    End Sub

    Private Sub PhoneBinding_Parse(ByVal sender As Object, ByVal e As ConvertEventArgs) Handles PhoneBinding.Parse
        Dim PhoneNumberAndExt As String = e.Value.ToString()

        Dim ExtIndex As Integer = PhoneNumberAndExt.IndexOf("x")
        Dim Ext As String = PhoneNumberAndExt.Substring(ExtIndex).Trim()
        Dim PhoneNumber As String = PhoneNumberAndExt.Substring(0, ExtIndex).Trim()

        ' Get the current binding object, and set the new extension manually. 
        Dim CurrentRow As DataRowView = CType(Me.BindingContext(EmployeesTable, "Employees").Current, DataRowView)
        ' Remove the "x" from the extension.
        CurrentRow("Extension") = CObj(Ext.Substring(1))

        ' Return the phone number.
        e.Value = PhoneNumber
    End Sub

    Private Sub NextButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles NextButton.Click
        Me.BindingContext(EmployeesTable, "Employees").Position = Me.BindingContext(EmployeesTable, "Employees").Position + 1
    End Sub

    Private Sub PreviousButton_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles PreviousButton.Click
        Me.BindingContext(EmployeesTable, "Employees").Position = Me.BindingContext(EmployeesTable, "Employees").Position - 1
    End Sub
End Class

#region Using directives

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Windows.Forms;
using System.Data.SqlClient;

#endregion

namespace MaskedTextBoxDataCSharp
{
    partial class Form1 : Form
    {
        Binding currentBinding, phoneBinding;
        DataSet employeesTable = new DataSet();
        SqlConnection sc;
        SqlDataAdapter dataConnect;

        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            DoMaskBinding();
        }

        private void DoMaskBinding()
        {
            try
            {
                sc = new SqlConnection("Data Source=localhost;Initial Catalog=NORTHWIND;Integrated Security=SSPI");
                sc.Open();
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
                return;
            }

            dataConnect = new SqlDataAdapter("SELECT * FROM Employees", sc);
            dataConnect.Fill(employeesTable, "Employees");


            // Now bind MaskedTextBox to appropriate field. Note that we must create the Binding objects
            // before adding them to the control - otherwise, we won't get a Format event on the 
            // initial load. 
            try
            {
                currentBinding = new Binding("Text", employeesTable, "Employees.FirstName");
                firstName.DataBindings.Add(currentBinding);

                currentBinding = new Binding("Text", employeesTable, "Employees.LastName");
                lastName.DataBindings.Add(currentBinding);

                phoneBinding =new Binding("Text", employeesTable, "Employees.HomePhone");
                // We must add the event handlers before we bind, or the Format event will not get called
                // for the first record.
                phoneBinding.Format += new ConvertEventHandler(phoneBinding_Format);
                phoneBinding.Parse += new ConvertEventHandler(phoneBinding_Parse);
                phoneMask.DataBindings.Add(phoneBinding);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
                return;
            }
        }

        private void phoneBinding_Format(Object sender, ConvertEventArgs e)
        {
            String ext;

            DataRowView currentRow = (DataRowView)BindingContext[employeesTable, "Employees"].Current;
            if (currentRow["Extension"] == null) 
            {
                ext = "";
            } else 
            {
                ext = currentRow["Extension"].ToString();
            }

            e.Value = e.Value.ToString().Trim() + " x" + ext;
        }

        private void phoneBinding_Parse(Object sender, ConvertEventArgs e)
        {
            String phoneNumberAndExt = e.Value.ToString();

            int extIndex = phoneNumberAndExt.IndexOf("x");
            String ext = phoneNumberAndExt.Substring(extIndex).Trim();
            String phoneNumber = phoneNumberAndExt.Substring(0, extIndex).Trim();

            //Get the current binding object, and set the new extension manually. 
            DataRowView currentRow = (DataRowView)BindingContext[employeesTable, "Employees"].Current;
            // Remove the "x" from the extension.
            currentRow["Extension"] = ext.Substring(1);

            //Return the phone number.
            e.Value = phoneNumber;
        }

        private void previousButton_Click(object sender, EventArgs e)
        {
            BindingContext[employeesTable, "Employees"].Position = BindingContext[employeesTable, "Employees"].Position - 1;
        }

        private void nextButton_Click(object sender, EventArgs e)
        {
            BindingContext[employeesTable, "Employees"].Position = BindingContext[employeesTable, "Employees"].Position + 1;
        }
    }
}

Compilation du code

Créez un projet Visual C# ou Visual Basic.
Ajoutez les contrôles TextBox et MaskedTextBox au formulaire, comme décrit dans la procédure précédente.
Ouvrez le fichier de code source pour le formulaire par défaut du projet.
Remplacez le code source dans ce fichier par le code répertorié dans la section "Code" précédente.
Compilez l'application.

Voir aussi

Tâches

Procédure pas à pas : utilisation du contrôle MaskedTextBox

Partager via