Cómo: Enlazar datos al control MaskedTextBox

Artículo
10/07/2008

Actualización: noviembre 2007

Puede enlazar datos a un control MaskedTextBox del mismo modo que cualquier otro control de formularios Windows Forms. No obstante, si el formato de los datos de la base de datos no coincide con el formato que se espera de la definición de máscara, será necesario volver a dar formato a los datos. En el procedimiento siguiente se muestra cómo hacerlo utilizando los eventos Format y Parse de la clase Binding para mostrar los campos de número de teléfono y extensión telefónica independientes como un solo campo modificable.

El procedimiento siguiente requiere que tenga acceso a una base de datos de SQL Server con la base de datos de ejemplo Northwind instalada.

Para enlazar datos a un control MaskedTextBox

Cree un nuevo proyecto de formularios Windows Forms.
Arrastre dos controles TextBox al formulario; asígnelos el nombre FirstName y LastName.
Arrastre un control MaskedTextBox al formulario; asígnelo el nombre PhoneMask.
Establezca la propiedad Mask de PhoneMask en (000) 000-0000 x9999.
Agregue las importaciones de espacio de nombres siguientes al formulario:
```
using System.Data.SqlClient;
```
```
Imports System.Data.SqlClient
```

Haga clic con el botón secundario del mouse (ratón) en el formulario y elija Ver código. Coloque este código en cualquier parte de la clase de formulario.

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

Agregue controladores de eventos para que los eventos Format y Parse combinen y separen los campos PhoneNumber y Extension del DataSet enlazado.

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

Agregue dos controles Button al formulario. Denomínelos previousButton y nextButton. Haga doble clic en cada botón para agregar un controlador de eventos Click y rellene los controladores de eventos como se muestra en el ejemplo de código siguiente.

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

Ejecute el ejemplo. Edite los datos y utilice los botones Anterior y Siguiente para comprobar que los datos se conservan correctamente en el DataSet.

Ejemplo

El ejemplo de código siguiente es la lista de código completa que se produce de completar el procedimiento anterior.

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;
        }
    }
}

Compilar el código

Cree un proyecto de Visual C# o Visual Basic.
Agregue los controles TextBox y MaskedTextBox al formulario, como se describe en el procedimiento anterior.
Abra el archivo de código fuente del formulario predeterminado del proyecto.
Reemplace el código fuente de este archivo con el código mostrado en la sección "Código" anterior.
Compile la aplicación.

Vea también

Tareas

Tutorial: Trabajar con el control MaskedTextBox

Compartir a través de