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

Observação

Os conjuntos de dados e as classes relacionadas são tecnologias herdadas do .NET Framework do início dos anos 2000 que permitem que os aplicativos trabalhem com dados na memória enquanto os aplicativos estão desconectados do banco de dados. As tecnologias são bastante úteis em aplicativos que permitem que os usuários modifiquem dados e persistam as alterações no banco de dados. Embora os conjuntos de dados tenham se mostrado uma tecnologia muito bem-sucedida, é recomendado que os novos aplicativos .NET usem o Entity Framework Core. O Entity Framework proporciona uma forma mais natural de trabalhar com dados tabulares como modelos de objeto e conta com uma interface de programação mais simples.

Ao exibir dados em formulários em aplicativos do Windows, você poderá escolher controles existentes na Caixa de Ferramentas. Ou poderá criar controles personalizados se o aplicativo exigir funcionalidade que não esteja disponível nos controles padrão. Este passo a passo mostra como criar um controle que implementa o ComplexBindingPropertiesAttribute. Os controles que implementam o ComplexBindingPropertiesAttribute contêm uma propriedade de DataSource e DataMember que pode ser associada a dados. Tais controles são semelhantes a um DataGridView ou ListBox.

Para obter mais informações sobre a criação de controles, confira Desenvolver controles do Windows Forms no tempo 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. Para obter mais informações, confira Criar um controle de usuário do Windows Forms que dá suporte à associação de dados simples.
Implemente o ComplexBindingPropertiesAttribute nos controles, como um DataGridView que exibe listas (ou tabelas) de dados. (Esse processo é descrito nesta página de passo a passo.)
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, confira Criar um controle de usuário do Windows Forms que dá suporte à associação de dados de pesquisa.

Este passo a passo cria um controle complexo que exibe linhas de dados de uma tabela. Este exemplo usa a tabela Customers do banco de dados de exemplo Northwind. O controle de usuário complexo exibirá a tabela de clientes em uma DataGridView no controle personalizado.

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

• Adicionar um novo Controle de Usuário ao projeto.

• Projetar visualmente o controle do usuário.

• Implementar o atributo ComplexBindingProperty.

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

• Defina a tabela Clientes na janela Fontes de Dados para usar o novo controle complexo.

• Adicionar o novo controle, arrastando-o da janela Fontes de Dados para Form1.

Pré-requisitos

Para concluir este passo a passo, você precisa das cargas de trabalho de Desenvolvimento de área de trabalho do .NET e Armazenamento de dados e processamento instaladas no Visual Studio. Para instalá-las, abra 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 da Northwind.

1. Se você não tiver SQL Server Express LocalDB, instale-o por meio da página de download do SQL Server Express ou usando o 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 da 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 Armazenamento e processamento de dados no Instalador do Visual Studio). Expanda o nó do 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 vai se abrir.

   2. Copie o script Transact-SQL da Northwind para sua área de transferência. Esse script T-SQL cria o banco de dados da Northwind do zero e o preenche com alguns 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, a consulta termina de ser executada e o banco de dados da Northwind é criado.

Crie um projeto de aplicativo do Windows Forms

A primeira etapa é criar um projeto Aplicativo do Windows Forms em C# ou Visual Basic. Nomeie o projeto como ComplexControlWalkthrough.

Adicionar um controle de usuário ao projeto

Como este passo a passo cria um controle associável a dados de um Controle de Usuário, adicione um item Controle de Usuário ao projeto:

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

2. Digite ComplexDataGridView na área Nome e selecione Adicionar.

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

Projetar o controle ComplexDataGridView

Para adicionar um DataGridView ao controle de usuário, arraste um DataGridView da Caixa de Ferramentas para a superfície de design do controle de usuário.

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

Para controles complexos que dão suporte à associação de dados, você pode implementar o ComplexBindingPropertiesAttribute:

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

2. Substitua o código no ComplexDataGridView pelo seguinte:

   C#

   using System.Windows.Forms;
   
   namespace CS
   {
       [System.ComponentModel.ComplexBindingProperties("DataSource", "DataMember")]
       public partial class ComplexDataGridView : UserControl
       {
           public object DataSource
           {
               get{ return dataGridView1.DataSource; }
               set{ dataGridView1.DataSource = value; }
           }
   
           public string DataMember
           {
               get{ return dataGridView1.DataMember; }
               set{ dataGridView1.DataMember = value; }
           }
   
           public ComplexDataGridView()
           {
               InitializeComponent();
           }
       }
   }
   

   VB

   <System.ComponentModel.ComplexBindingProperties("DataSource", "DataMember")>
   Public Class ComplexDataGridView
   
       Public Property DataSource() As Object
           Get
               Return DataGridView1.DataSource
           End Get
           Set(ByVal value As Object)
               DataGridView1.DataSource = value
           End Set
       End Property
   
       Public Property DataMember() As String
           Get
               Return DataGridView1.DataMember
           End Get
           Set(ByVal value As String)
               DataGridView1.DataMember = value
           End Set
       End Property
   End Class
   

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

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

Use 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:

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

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

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

4. Na página Escolha a Conexão de Dados, faça o seguinte:

   • 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 inicializar 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, em seguida, selecione Avançar.

6. Na página Salvar cadeia de conexão no arquivo de Configuração de Aplicativo, clique em Avançar.

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

8. Escolha a tabela Customers e selecione Concluir.

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

Definir a tabela Clientes para usar o controle ComplexDataGridView

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 Personalizar.

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

5. Clique na seta da lista suspensa na tabela Customers e escolha ComplexDataGridView na lista de controle.

Adicionar controles ao formulário

Você pode criar controles de associação de dados arrastando itens da janela Fontes de Dados para um formulário. Arraste o nó principal Clientes da janela Fontes de Dados para o formulário. Verifique se o controle ComplexDataGridView é usado para exibir os dados da tabela.

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 pesquisa. Para obter mais informações, confira 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 quando arrastado da janela Fontes de Dados
• Controles dos Windows Forms