Criar um controle de usuário do Windows Forms do .NET Framework que dê suporte à associação de dados simples

Ao exibir dados em formulários em aplicativos do Windows, você pode escolher controles existentes na Caixa de Ferramentas ou criar controles personalizados se o aplicativo exigir funcionalidades que não estão disponíveis nos controles padrão. Este passo a passo mostra como criar um controle que implementa o DefaultBindingPropertyAttribute. Os controles que implementam a DefaultBindingPropertyAttribute podem conter uma propriedade que pode ser associada a dados. Esses controles são semelhantes a um TextBox ou CheckBox.

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

Ao criar controles para uso em cenários de associação de dados, você deve implementar um dos seguintes atributos de associação de dados:

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 de usuário simples exibe os números de telefone dos clientes em um formato de número de telefone padrão, usando um MaskedTextBox e definindo a máscara como um número de telefone.

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

• Crie um novo aplicativo do Windows Forms (.NET Framework).

• Adicione um novo Controle de Usuário ao seu projeto.

• Projete visualmente o controle do usuário.

• Implemente o DefaultBindingProperty atributo.

• Crie um conjunto de dados com o assistente de Configuração da Fonte de Dados .

• Defina a coluna Telefone na janela Fontes de Dados para usar o novo controle.

• Crie um formulário para exibir dados no novo controle.

Pré-requisitos

Para concluir este tutorial, você precisa das cargas de trabalho de desenvolvimento e armazenamento e processamento de dados do .NET instaladas no Visual Studio. Para instalá-los, abra do Instalador do Visual Studio e escolha Modificar (ou Mais>Modificar) ao lado da versão do Visual Studio que você deseja modificar. Confira Modificar o Visual Studio.

Este passo a passo usa o SQL Server Express LocalDB e o banco de dados de exemplo Northwind.

1. Se você não tiver o SQL Server Express LocalDB, instale-o na página de download do SQL Server Express ou por meio do Instalador do Visual Studio. No Instalador do Visual Studio, você pode instalar o SQL Server Express LocalDB como parte da carga de trabalho Armazenamento e processamento de dados ou como um componente individual.

2. Instale o banco de dados de exemplo Northwind seguindo estas etapas:

   1. No Visual Studio, abra a janela Pesquisador de Objetos do SQL Server. (O Pesquisador de Objetos do SQL Server é instalado como parte da carga de trabalho de armazenamento e processamento de dados no Instalador do Visual Studio.) Expanda o nó SQL Server. Clique com o botão direito do mouse na instância do LocalDB e selecione Nova Consulta.

      Uma janela do editor de consultas é aberta.

   2. Copie o script Transact-SQL da Northwind para sua área de transferência. Esse script T-SQL cria o banco de dados Northwind do zero e o preenche com dados.

   3. Cole o script T-SQL no editor de consultas e, em seguida, escolha o botão Executar.

      Após um curto período de tempo, a consulta termina de ser executada e o banco de dados Northwind é criado.

Criar um aplicativo do Windows Forms

A primeira etapa é criar um aplicativo do Windows Forms (.NET Framework):

1. No Visual Studio, no menu Arquivo, selecione Novo>Projeto.

2. Expanda o Visual C# ou o Visual Basic no painel esquerdo e selecione a Área de Trabalho do Windows.

3. No painel do meio, selecione o tipo de projeto de Aplicativo do Windows Forms .

4. Nomeie o projeto SimpleControlWalkthrough e escolha OK.

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

Adicionar um controle de usuário ao projeto

Este passo a passo cria um controle simples vinculável a dados a partir de um Controle de Usuário. Adicione um item de Controle de Usuário ao projeto SimpleControlWalkthrough :

1. No menu Projeto , escolha Adicionar Controle de Usuário.

2. Digite PhoneNumberBox na área Nome e clique em Adicionar.

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

Projetar o controle PhoneNumberBox

Este passo a passo se expande sobre o existente MaskedTextBox para criar o controle PhoneNumberBox :

1. Arraste um MaskedTextBox da Caixa de Ferramentas para a superfície de design do controle de usuário.

2. Selecione a marca inteligente no MaskedTextBox que você acabou de arrastar e escolha Definir Máscara.

3. Selecione o número de telefone na caixa de diálogo Máscara de Entrada e clique em OK para definir a máscara.

Adicionar o atributo de associação de dados necessário

Para controles simples que dão suporte à vinculação de dados, implemente o DefaultBindingPropertyAttribute:

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

2. Substitua o código na PhoneNumberBox pelo seguinte:

   • C#
   • VB

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

3. No menu Compilar , escolha Criar Solução.

Criar uma fonte de dados a partir do seu banco de dados

Esta etapa usa o assistente de Configuração da Fonte de Dados para criar uma fonte de dados com base na Customers tabela no banco de dados de exemplo Northwind. Você deve 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.

1. Para abrir a janela Fontes de Dados , no menu Dados , clique em Mostrar Fontes de Dados.

2. Na janela Fontes de Dados , selecione Adicionar Nova Fonte de Dados para iniciar o assistente de Configuração da Fonte de Dados .

3. Na página Escolher um Tipo de Fonte de Dados , selecione Banco de Dados e selecione Avançar.

4. Na página Escolher Sua Conexão de Dados , siga um destes procedimentos:

   • Se uma conexão de dados com o banco de dados de exemplo Northwind estiver disponível na lista suspensa, selecione-a.

   • Selecione Nova Conexão para iniciar a caixa de diálogo Adicionar/Modificar Conexão .

5. Se o banco de dados exigir uma senha, selecione a opção para incluir dados confidenciais e selecione Avançar.

6. Na página Salvar string de conexão no arquivo de configuração do aplicativo, clique em Avançar.

7. Expanda o nó Tabelas na página Escolher Objetos do Banco de Dados.

8. Selecione a Customers tabela e, em seguida, selecione Concluir.

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

Configure a coluna de 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:

1. Abra Form1 no designer.

2. Expanda o nó Clientes na janela Fontes de Dados.

3. Clique na seta da lista suspensa no nó Clientes e escolha Detalhes na lista de controle.

4. Clique na seta da lista suspensa na coluna Telefone e escolha Personalizar.

5. Selecione a PhoneNumberBox na lista de Controles Associados na caixa de diálogo Opções de Personalização da Interface do Usuário de Dados.

6. Clique na seta da lista suspensa na coluna Telefone e escolha PhoneNumberBox.

Adicionar controles ao formulário

Você pode criar os controles associados a dados arrastando itens da janela Fontes de Dados para o formulário.

Para criar controles associados a 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 os dados na coluna Telefone .

Controles associados a dados com rótulos descritivos aparecem no formulário, juntamente com uma faixa de ferramentas (BindingNavigator) para navegar em registros. Um NorthwindDataSet, CustomersTableAdapter BindingSourcee BindingNavigator aparecem na bandeja de componentes.

Executar o aplicativo

Pressione F5 para executar o aplicativo.

Próximas etapas

Dependendo dos requisitos do aplicativo, talvez você queira executar várias etapas depois de criar um controle que dê suporte à associação de dados. Algumas próximas etapas típicas incluem:

• Colocando seus controles personalizados em uma biblioteca de controles para que você possa reutilizá-los em outros aplicativos.

• Criando controles que dão suporte a cenários de associação de dados mais complexos. Para obter mais informações, consulte Criar um controle de usuário do Windows Forms que dá suporte à associação de dados complexa e criar um controle de usuário do Windows Forms que dê suporte à associação de dados de pesquisa.

Conteúdo relacionado

• Associar controles do Windows Forms a dados no Visual Studio
• Definir o controle a ser criado ao arrastar da janela Fontes de Dados