Instruções passo a passo: criando um controle de usuário dos Windows Forms que dá suporte à vinculação de dados simples

Artigo
06/10/2015

Ao exibir dados em formulários nos aplicativos do Windows, você pode escolher os controles existentes da Caixa de Ferramentas ou criar controles personalizados se seu aplicativo exigir alguma funcionalidade que não esteja disponível nos controles padrão. Este passo a passo mostra como criar um controle que implementa o DefaultBindingPropertyAttribute. Os controles que implementam o DefaultBindingPropertyAttribute contêm uma propriedade que pode ser associada a dados. Tais controles são semelhantes a um TextBox ou CheckBox.

Para obter mais informações sobre criação de controle, consulte Desenvolvendo controles dos Windows Forms na hora de design.

Ao criar controles para uso em cenários de associação de dados, é necessário implementar um dos seguintes atributos de associação de dados:

Uso do atributo de associação de dados
Implemente o DefaultBindingPropertyAttribute em controles simples, como um TextBox, que exibe uma única coluna (ou propriedade) de dados. (Esse processo é descrito nesta página de passo a passo.)
Implemente o ComplexBindingPropertiesAttribute nos controles, como um DataGridView que exibe listas (ou tabelas) de dados. Para obter mais informações, consulte Instruções passo a passo: criando um controle de usuário dos Windows Forms que dá suporte à vinculação de dados complexos.
Implemente o LookupBindingPropertiesAttribute nos controles, como um ComboBoxque exibe listas (ou tabelas) de dados, mas também precisa apresentar uma única coluna ou propriedade. Para obter mais informações, consulte Instruções passo a passo: criando um controle de usuário dos Windows Forms que dá suporte à vinculação de dados de pesquisa.

Este passo a passo cria um controle simples que exibe dados de uma única coluna em uma tabela. Este exemplo usa a coluna Phone da tabela Customers do banco de dados de exemplo Northwind. O controle simples de usuário exibirá números de telefone do cliente em um formato padrão por meio de um MaskedTextBox e configurará a máscara para um número de telefone.

Durante este passo a passo, você aprenderá a:

Criar um novo Aplicativo do Windows.
Adicionar um novo Controle de Usuário ao projeto.
Projetar visualmente o controle do usuário.
Implementar o atributo DefaultBindingProperty.
Criar um conjunto de dados com o Assistente para Configuração da Fonte de Dados.
Definir a coluna Telefone na janela Fontes de Dados para usar o novo controle.
Criar um formulário para exibir dados no novo controle.

Pré-requisitos

Para concluir este passo a passo, você precisará de:

Acesso ao banco de dados de exemplo Northwind. Para obter mais informações, consulte Como instalar bancos de dados de exemplo.

Criando um aplicativo do Windows

A primeira etapa é criar um Aplicativo do Windows.

Para criar o novo projeto do Windows

No Visual Studio, no menu Arquivo, crie um novo Projeto.
Nomeie o projeto como SimpleControlWalkthrough.
Selecione Aplicativo do Windows e clique em OK. Para obter mais informações, consulte Implementando aplicativos cliente com o .NET Framework.

O projeto SimpleControlWalkthrough é criado e adicionado ao Gerenciador de Soluções.

Adicionando um controle de usuário ao projeto

Este passo a passo cria um controle associável a dados a partir de um Controle de Usuário, portanto, adicione um item de Controle de Usuário ao projeto SimpleControlWalkthrough.

Para adicionar um controle de usuário ao projeto

No menu Projeto, escolha Adicionar Controle do Usuário.
Digite PhoneNumberBox na área Nome e clique em Adicionar.

O controle PhoneNumberBox é adicionado ao Gerenciador de Soluções e abre no designer.

Projetando o controle PhoneNumberBox

Este passo a passo expande o MaskedTextBox existente para criar o controle PhoneNumberBox.

Para projetar o controle PhoneNumberBox

Arraste um MaskedTextBox da Caixa de Ferramentas para a superfície de design do controle de usuário.
Selecione a marca inteligente no MaskedTextBox que você acabou de arrastar e selecione Definir Máscara.
Selecione Número do telefone na caixa de diálogo Máscara de Entrada e clique em OK para configurar a máscara.

Adicionando o atributo obrigatório de associação de dados

Para controles simples que suportam associação de dados, implemente o DefaultBindingPropertyAttribute.

Para implementar o atributo DefaultBindingProperty

Alterne o controle PhoneNumberBox para exibição de código. (No menu Exibir, escolha Código.)

Substitua o código no PhoneNumberBox pelo seguinte:

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

Do criar menu, escolha Build Solution.

Criando uma fonte de dados a partir de seu banco de dados

Esta etapa usa o Assistente de Configuração de Fonte de Dados para criar uma fonte de dados com base na tabela Customers no banco de dados de exemplo Northwind. É preciso ter acesso ao banco de dados de exemplo Northwind para criar a conexão. Para obter informações sobre como configurar o banco de dados de exemplo Northwind, consulte Como instalar bancos de dados de exemplo.

Para criar a fonte de dados

No menu Dados, clique em Mostrar Fontes de Dados.
Na janela Fontes de Dados, selecione Adicionar Nova Fonte de Dados para iniciar o Assistente de Configuração de Fonte de Dados.
Selecione Base de dados na página Escolher um Tipo de Fonte de Dados e, em seguida, clique em Próximo.
Sobre o Escolha sua conexão de dados página faça o seguinte:
- Se uma conexão de dados no banco de dados de exemplo Northwind estiver disponível na lista suspensa, selecione-o.
  
  Ou
- Selecione Nova Conexão para iniciar a caixa Adicionar/Modificar Conexão.
Se o banco de dados exigir uma senha, selecione a opção para incluir dados confidenciais e, em seguida, clique em Próximo.
Clique em Avançar na página Salvar cadeia de caracteres de conexão no arquivo de configuração do aplicativo.
Expanda o nó Tabelas na página Escolher Objetos do Banco de Dados.
Selecione a tabela Customers e clique em Concluir.

O NorthwindDataSet é adicionado ao projeto e a tabela Customers aparece na janela Fontes de Dados.

Definindo a coluna telefone para usar o Controle PhoneNumberBox

Na janela Fontes de Dados, você pode definir o controle a ser criado antes de arrastar itens para seu formulário.

Para definir a coluna telefone para se associar ao controle PhoneNumberBox

Abra Form1 no designer.
Expanda o nó Clientes na janela Fontes de Dados.
Clique na seta suspensa no nó Clientes e escolha Detalhes na lista de controle.
Clique na seta suspensa na coluna Telefone e escolha Personalizar.
Selecione PhoneNumberBox na lista de Controles Associados na caixa de diálogo Opções de Personalização da IU de Dados.
Clique na seta suspensa na coluna Telefone e escolha PhoneNumberBox.

Adicionando controles ao formulário

É possível criar controles de associação de dados ao arrastar itens da janela Fontes de Dados para o formulário.

Para criar controles de associação de dados no formulário

Arraste o nó principal Clientes da janela Fontes de Dados para o formulário e verifique se o controle PhoneNumberBox é usado para exibir dados na coluna Phone.

Os controles de associação de dados com rótulos descritivos são exibidos no formulário, juntamente com uma faixa de ferramentas (BindingNavigator) para registros de navegação. Um NorthwindDataSet, CustomersTableAdapter, BindingSource e BindingNavigator são exibidos na bandeja de componentes.

Executando o aplicativo

Para executar o aplicativo

Pressione F5 para executar o aplicativo.

Próximas etapas

Dependendo dos requisitos do aplicativo, existem várias etapas que você pode realizar após criar um controle com suporte a associação de dados. Algumas etapas seguintes típicas incluem:

Colocando os controles personalizados em uma biblioteca de controles para que você possa reutilizá-los em outros aplicativos.
Criando controles que suportam cenários de associação de dados mais complexos. Para obter mais informações, consulte Instruções passo a passo: criando um controle de usuário dos Windows Forms que dá suporte à vinculação de dados complexos e Instruções passo a passo: criando um controle de usuário dos Windows Forms que dá suporte à vinculação de dados de pesquisa.

Consulte também

Compartilhar via