Créer un contrôle utilisateur Windows Forms .NET Framework qui prend en charge la liaison de données simple

Remarque

Les jeux de données et les classes associées sont des technologies .NET Framework héritées qui datent du début des années 2000. Elles permettent aux applications d’utiliser des données en mémoire pendant que les applications sont déconnectées de la base de données. Elles sont particulièrement utiles aux applications qui permettent aux utilisateurs de modifier des données, et de rendre ces changements persistants dans la base de données. Même si les jeux de données sont une technologie très efficace, nous vous recommandons d’utiliser Entity Framework Core pour les nouvelles applications .NET. Entity Framework offre un moyen plus naturel d’utiliser des données tabulaires en tant que modèles objet. De plus, il présente une interface de programmation plus simple.

Pour présenter des données dans des formulaires d’applications Windows, vous pouvez choisir des contrôles existants dans la Boîte à outils ou créer des contrôles personnalisés si votre application nécessite des fonctionnalités qui ne sont pas disponibles dans les contrôles standard. Cette procédure pas à pas vous indique comment créer un contrôle qui implémente l'objet DefaultBindingPropertyAttribute. Les contrôles qui implémentent DefaultBindingPropertyAttribute peuvent contenir une propriété pouvant être liée aux données. Ce type de contrôles est similaire à TextBox ou CheckBox.

Pour plus d’informations sur la création de contrôles, consultez Développement de contrôles Windows Forms au moment du design.

Quand vous créez des contrôles utilisables dans des scénarios de liaison de données, vous devez implémenter l’un des attributs Databinding suivants :

Utilisation de l'attribut Databinding
Implémentez DefaultBindingPropertyAttribute sur des contrôles simples, comme TextBox, qui affichent une seule colonne (ou propriété) de données. (Ce processus est décrit dans cette page de procédure pas à pas.)
Implémentez ComplexBindingPropertiesAttribute sur des contrôles, comme DataGridView, qui affichent des listes (ou tables) de données. Pour plus d’informations, consultez Créer un contrôle utilisateur Windows Forms qui prend en charge la liaison de données complexe.
Implémentez l'objet LookupBindingPropertiesAttribute sur des contrôles, comme ComboBox, qui affichent des listes (ou tables) de données, mais doivent également présenter une seule colonne ou propriété. Pour plus d’informations, consultez Créer un contrôle utilisateur Windows Forms qui prend en charge la liaison de données de recherche.

Cette procédure pas à pas crée un contrôle simple qui affiche les données d'une seule colonne dans une table. Cet exemple utilise la colonne Phone de la table Customers de l'exemple de base de données Northwind. Le contrôle utilisateur simple affiche les numéros de téléphone des clients dans un format de numéro de téléphone standard à l'aide d'un MaskedTextBox et en définissant le masque sur un numéro de téléphone.

Pendant cette procédure pas à pas, vous allez apprendre à :

  • Créez une nouvelle Application Windows Forms (.NET Framework).

  • Ajouter un nouveau Contrôle utilisateur à votre projet.

  • Concevoir visuellement le contrôle utilisateur.

  • Implémenter l'attribut DefaultBindingProperty.

  • Créez un jeu de données avec l’Assistant Configuration de la source de données.

  • Définir la colonne Phone dans la fenêtre Sources de données pour qu’elle utilise le nouveau contrôle.

  • Créer un formulaire pour afficher des données dans le nouveau contrôle.

Prérequis

Pour effectuer ce tutoriel, vous devez installer les charges de travail Développement de bureau .NET et Stockage et traitement des données dans Visual Studio. Pour les installer, ouvrez Visual Studio Installer et choisissez Modifier (ou Plus>Modifier) en regard de la version de Visual Studio que vous souhaitez modifier. Consultez Modifier Visual Studio.

Cette procédure pas à pas utilise SQL Server Express LocalDB et l’exemple de base de données Northwind.

  1. Si SQL Server Express LocalDB n’est pas installé, installez-le à partir de la page de téléchargement SQL Server Express, ou via le programme d’installation Visual Studio Installer. Dans Visual Studio Installer, vous pouvez installer la base de données locale SQL Server Express dans le cadre de la charge de travail Traitement et stockage de données, ou l’installer comme un composant seul.

  2. Installez l’exemple de base de données Northwind en procédant comme suit :

    1. Dans Visual Studio, ouvrez la fenêtre de l’Explorateur d’objets SQL Server. (L’Explorateur d’objets SQL Server est installé dans le cadre de la charge de travail stockage de données et du traitement dans Visual Studio Installer.) Développez le nœud SQL Server. Cliquez avec le bouton droit sur votre instance LocalDB et sélectionnez Nouvelle requête.

      Une fenêtre d’éditeur de requête s’ouvre.

    2. Copiez le script Northwind Transact-SQL dans votre Presse-papiers. Ce script T-SQL crée la base de données Northwind à partir de zéro et la remplit avec des données.

    3. Collez le script T-SQL dans l’éditeur de requête, puis cliquez sur le bouton Exécuter.

      Peu de temps après, la requête se termine et la base de données Northwind est créée.

Créer une application Windows Forms

La première étape consiste à créer une application Windows Forms (.NET Framework) :

  1. Dans Visual Studio, dans le menu Fichier, sélectionnez Nouveau>Projet.

  2. Développez Visual C# ou Visual Basic dans le volet gauche, puis sélectionnez Windows Desktop.

  3. Dans le volet central, sélectionnez le type de projet d’application Windows Forms.

  4. Nommez le projet SimpleControlWalkthrough, puis choisissez OK.

    Le projet SimpleControlWalkthrough est créé et ajouté à l’Explorateur de solutions.

Ajouter un contrôle utilisateur au projet

Cette procédure pas à pas crée un contrôle de liaison de données à partir d’un contrôle utilisateur. Ajoutez un élément de contrôle utilisateur au projet SimpleControlWalkthrough :

  1. Dans le menu Projet, choisissez Ajouter un contrôle utilisateur.

  2. Tapez PhoneNumberBox dans la zone Nom, puis cliquez sur Ajouter.

    Le contrôle PhoneNumberBox est ajouté à l’Explorateur de solutions et s’ouvre dans le concepteur.

Concevoir le contrôle PhoneNumberBox

Cette procédure pas à pas développe le MaskedTextBox existant pour créer le contrôle PhoneNumberBox :

  1. Faites glisser un MaskedTextBox depuis la Boîte à outils vers l’aire de conception du contrôle utilisateur.

  2. Sélectionnez la balise active du MaskedTextBox que vous venez de faire glisser et choisissez Définir le masque.

  3. Sélectionnez Numéro de téléphone dans la boîte de dialogue Masque de saisie et cliquez sur OK pour définir le masque.

Ajouter l’attribut de liaison de données requis

Pour des contrôles simples prenant en charge la liaison de données, implémentez DefaultBindingPropertyAttribute :

  1. Faites passer le contrôle PhoneNumberBox en vue Code. (Dans le menu Affichage, choisissez Code.)

  2. Remplacez le code dans le PhoneNumberBox par ce qui suit :

    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. Dans le menu Générer , cliquez sur Générer la solution.

Création d’une source de données à partir de votre base de données

Cette étape utilise l’Assistant Configuration de source de données pour créer une source de données basée sur la table Customers de l’exemple de base de données Northwind. Vous devez avoir accès à l'exemple de base de données Northwind pour créer la connexion. Pour plus d’informations sur la configuration de l’exemple de base de données Northwind, consultez Guide pratique pour installer des exemples de bases de données.

  1. Pour ouvrir la fenêtre Sources de données, dans le menu Données, cliquez sur Afficher les sources de données.

  2. Dans la fenêtre Sources de données, sélectionnez Ajouter une nouvelle source de données pour démarrer l’Assistant Configuration de source de données.

  3. Dans la page Choisir un type de source de données, sélectionnez Base de données, puis cliquez sur Suivant.

  4. Dans la page Choisir votre connexion de données, effectuez l’une des opérations suivantes :

    • Si une connexion de données à l'exemple de base de données Northwind est disponible dans la liste déroulante, sélectionnez-la.

    • Sélectionnez Nouvelle connexion pour afficher la boîte de dialogue Ajouter/Modifier la connexion.

  5. Si votre base de données nécessite un mot de passe, sélectionnez l’option pour inclure les données sensibles, puis cliquez sur Suivant.

  6. Dans la page Enregistrer la chaîne de connexion dans le fichier de configuration de l’application, cliquez sur Suivant.

  7. Dans la page Choisir vos objets de base de données, développez le nœud Tables.

  8. Sélectionnez la table Customers, puis cliquez sur Terminer.

    NorthwindDataSet est ajouté à votre projet et la table Customers apparaît dans la fenêtre Sources de données.

Définir la colonne Phone pour qu'elle utilise le contrôle PhoneNumberBox

Dans la fenêtre Sources de données, vous pouvez définir le contrôle à créer avant de faire glisser des éléments vers votre formulaire :

  1. Ouvrez Form1 dans le concepteur.

  2. Développez le nœud Customers dans la fenêtre Sources de données.

  3. Cliquez sur la flèche déroulante du nœud Customers et choisissez Détails dans la liste de contrôles.

  4. Cliquez sur la flèche déroulante de la colonne Phone et choisissez Personnaliser.

  5. Sélectionnez PhoneNumberBox dans la liste des Contrôles associés de la boîte de dialogue Options de personnalisation de l’interface utilisateur de données.

  6. Cliquez sur la flèche déroulante de la colonne Phone et choisissez PhoneNumberBox.

Ajouter des contrôles au formulaire

Pour créer des contrôles liés aux données, vous pouvez faire glisser des éléments depuis la fenêtre Sources de données vers le formulaire.

Pour créer des contrôles liés aux données sur le formulaire faites glisser le nœud Client de la fenêtre Sources de données vers le formulaire et vérifiez que le contrôle PhoneNumberBox est utilisé pour afficher les données dans la colonne Phone.

Les contrôles liés aux données assortis d'étiquettes descriptives apparaissent dans le formulaire, ainsi qu'une barre d'outils (BindingNavigator) pour parcourir les enregistrements. NorthwindDataSet, CustomersTableAdapter, BindingSource et BindingNavigator s’affichent dans la barre d’état des composants.

Exécution de l'application

Appuyez sur F5 pour exécuter l'application.

Étapes suivantes

En fonction des spécifications de votre application, vous pouvez exécuter différentes étapes après la création d’un contrôle prenant en charge la liaison de données. Les étapes ultérieures sont habituellement celles-ci :