Guide pratique pour développer un contrôle Windows Forms simple

Cette section vous guide à travers les étapes clés de création d’un contrôle Windows Forms personnalisé. Le contrôle simple développé dans cette procédure pas à pas permet de modifier l’alignement de sa Text propriété. Il ne permet pas de déclencher ni de gérer des événements.

Pour créer un contrôle personnalisé simple

1. Définissez une classe qui dérive de System.Windows.Forms.Control.

   Public Class FirstControl
      Inherits Control
   
   End Class
   

   public class FirstControl:Control {}
   

2. Définissez des propriétés. (Vous n’êtes pas obligé de définir des propriétés, car un contrôle hérite de nombreuses propriétés de la Control classe, mais la plupart des contrôles personnalisés définissent généralement des propriétés supplémentaires.) Le fragment de code suivant définit une propriété nommée TextAlignment qui FirstControl utilise pour mettre en forme l’affichage de la Text propriété héritée de Control. Pour plus d’informations sur la définition des propriétés, consultez Vue d’ensemble des propriétés.

   // ContentAlignment is an enumeration defined in the System.Drawing
   // namespace that specifies the alignment of content on a drawing
   // surface.
   private ContentAlignment alignmentValue = ContentAlignment.MiddleLeft;
   

   ' ContentAlignment is an enumeration defined in the System.Drawing
   ' namespace that specifies the alignment of content on a drawing 
   ' surface.
   Private alignmentValue As ContentAlignment = ContentAlignment.MiddleLeft
   
   <Category("Alignment"), Description("Specifies the alignment of text.")> _
   Public Property TextAlignment() As ContentAlignment
      
      Get
         Return alignmentValue
      End Get
      Set
         alignmentValue = value
         
         ' The Invalidate method invokes the OnPaint method described 
         ' in step 3.
         Invalidate()
      End Set
   End Property
   

   Lorsque vous définissez une propriété qui modifie l’affichage visuel du contrôle, vous devez appeler la Invalidate méthode pour redessiner le contrôle. Invalidate est défini dans la classe Controlde base .

3. Remplacez la méthode protégée OnPaint héritée pour fournir une logique de Control rendu à votre contrôle. Si vous ne remplacez OnPaintpas, votre contrôle ne pourra pas se dessiner lui-même. Dans le fragment de code suivant, la OnPaint méthode affiche la Text propriété héritée de Control l’alignement spécifié par le alignmentValue champ.

   protected override void OnPaint(PaintEventArgs e)
   {
       base.OnPaint(e);
       StringFormat style = new StringFormat();
       style.Alignment = StringAlignment.Near;
       switch (alignmentValue)
       {
           case ContentAlignment.MiddleLeft:
               style.Alignment = StringAlignment.Near;
               break;
           case ContentAlignment.MiddleRight:
               style.Alignment = StringAlignment.Far;
               break;
           case ContentAlignment.MiddleCenter:
               style.Alignment = StringAlignment.Center;
               break;
       }
   
       // Call the DrawString method of the System.Drawing class to write
       // text. Text and ClientRectangle are properties inherited from
       // Control.
       e.Graphics.DrawString(
           Text,
           Font,
           new SolidBrush(ForeColor),
           ClientRectangle, style);
   }
   

   Protected Overrides Sub OnPaint(e As PaintEventArgs)
   
      MyBase.OnPaint(e)
      Dim style As New StringFormat()
      style.Alignment = StringAlignment.Near
      Select Case alignmentValue
         Case ContentAlignment.MiddleLeft
            style.Alignment = StringAlignment.Near
         Case ContentAlignment.MiddleRight
            style.Alignment = StringAlignment.Far
         Case ContentAlignment.MiddleCenter
            style.Alignment = StringAlignment.Center
      End Select
      
      ' Call the DrawString method of the System.Drawing class to write   
      ' text. Text and ClientRectangle are properties inherited from
      ' Control.
      e.Graphics.DrawString( _
          me.Text, _
          me.Font, _
          New SolidBrush(ForeColor), _
          RectangleF.op_Implicit(ClientRectangle), _
          style)
   
   End Sub
   

4. Fournissez des attributs à votre contrôle. Les attributs permettent à un concepteur visuel d’afficher correctement votre contrôle ainsi que ses propriétés et événements au moment du design. Le fragment de code suivant applique des attributs à la propriété TextAlignment. Dans un concepteur tel que Visual Studio, l’attribut Category (illustré dans le fragment de code) entraîne l’affichage de la propriété sous une catégorie logique. L’attribut Description entraîne l’affichage d’une chaîne descriptive en bas de la fenêtre Propriétés lorsque la TextAlignment propriété est sélectionnée. Pour plus d’informations sur les attributs, consultez Attributs en mode design pour les composants.

   [
   Category("Alignment"),
   Description("Specifies the alignment of text.")
   ]
   

   <Category("Alignment"), Description("Specifies the alignment of text.")> _
   Public Property TextAlignment() As ContentAlignment
   

5. (facultatif) Fournissez des ressources pour votre contrôle. Vous pouvez fournir une ressource, par exemple une image bitmap, pour votre contrôle en utilisant une option de compilateur (/res pour C#) afin d’empaqueter des ressources avec votre contrôle. Au moment de l’exécution, la ressource peut être récupérée à l’aide des méthodes de la ResourceManager classe. Pour plus d’informations sur la création et l’utilisation de ressources, consultez Ressources dans des applications de bureau.

6. Compilez et déployez votre contrôle. Pour compiler et déployer FirstControl,, procédez comme suit :

   1. Enregistrez le code de l’exemple suivant dans un fichier source (par exemple, FirstControl.cs ou FirstControl.vb).

   2. Compilez le code source dans un assembly et enregistrez-le dans le répertoire de votre application. Pour ce faire, exécutez la commande suivante à partir du répertoire qui contient le fichier source.

      vbc -t:library -out:[path to your application's directory]/CustomWinControls.dll -r:System.dll -r:System.Windows.Forms.dll -r:System.Drawing.dll FirstControl.vb
      

      csc -t:library -out:[path to your application's directory]/CustomWinControls.dll -r:System.dll -r:System.Windows.Forms.dll -r:System.Drawing.dll FirstControl.cs
      

      L’option du compilateur /t:library indique au compilateur que l’assembly créé est une bibliothèque (et non un exécutable). L’option /out spécifie le chemin d’accès et le nom de l’assembly. L’option /r fournit le nom des assemblys référencés par votre code. Dans cet exemple, vous créez un assembly privé que seules vos applications peuvent utiliser. Par conséquent, vous devez l’enregistrer dans le répertoire de votre application. Pour plus d’informations sur l’empaquetage et le déploiement d’un contrôle à des fins de distribution, consultez Déploiement.

L’exemple suivant présente le code pour FirstControl. Le contrôle est inséré dans l’espace de noms CustomWinControls. Un espace de noms fournit un regroupement logique des types connexes. Vous pouvez créer votre contrôle dans un espace de noms nouveau ou existant. En C#, la déclaration using (en Visual Basic, Imports) autorise l’accès aux types à partir d’un espace de noms sans le nom qualifié complet du type. Dans l’exemple suivant, la using déclaration permet au code d’accéder à la classe ControlSystem.Windows.Forms comme simplement Control au lieu d’utiliser le nom System.Windows.Forms.Controlcomplet.

using System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;

namespace CustomWinControls
{
    public class FirstControl : Control
    {

        public FirstControl()
        {
        }

        // ContentAlignment is an enumeration defined in the System.Drawing
        // namespace that specifies the alignment of content on a drawing
        // surface.
        private ContentAlignment alignmentValue = ContentAlignment.MiddleLeft;

        [
        Category("Alignment"),
        Description("Specifies the alignment of text.")
        ]
        public ContentAlignment TextAlignment
        {

            get
            {
                return alignmentValue;
            }
            set
            {
                alignmentValue = value;

                // The Invalidate method invokes the OnPaint method described
                // in step 3.
                Invalidate();
            }
        }

        protected override void OnPaint(PaintEventArgs e)
        {
            base.OnPaint(e);
            StringFormat style = new StringFormat();
            style.Alignment = StringAlignment.Near;
            switch (alignmentValue)
            {
                case ContentAlignment.MiddleLeft:
                    style.Alignment = StringAlignment.Near;
                    break;
                case ContentAlignment.MiddleRight:
                    style.Alignment = StringAlignment.Far;
                    break;
                case ContentAlignment.MiddleCenter:
                    style.Alignment = StringAlignment.Center;
                    break;
            }

            // Call the DrawString method of the System.Drawing class to write
            // text. Text and ClientRectangle are properties inherited from
            // Control.
            e.Graphics.DrawString(
                Text,
                Font,
                new SolidBrush(ForeColor),
                ClientRectangle, style);
        }
    }
}

Imports System.Drawing
Imports System.Collections
Imports System.ComponentModel
Imports System.Windows.Forms


Public Class FirstControl
   Inherits Control

   Public Sub New()
   End Sub 
   
   
   ' ContentAlignment is an enumeration defined in the System.Drawing
   ' namespace that specifies the alignment of content on a drawing 
   ' surface.
   Private alignmentValue As ContentAlignment = ContentAlignment.MiddleLeft
   
   <Category("Alignment"), Description("Specifies the alignment of text.")> _
   Public Property TextAlignment() As ContentAlignment
      
      Get
         Return alignmentValue
      End Get
      Set
         alignmentValue = value
         
         ' The Invalidate method invokes the OnPaint method described 
         ' in step 3.
         Invalidate()
      End Set
   End Property
   
   
   Protected Overrides Sub OnPaint(e As PaintEventArgs)

      MyBase.OnPaint(e)
      Dim style As New StringFormat()
      style.Alignment = StringAlignment.Near
      Select Case alignmentValue
         Case ContentAlignment.MiddleLeft
            style.Alignment = StringAlignment.Near
         Case ContentAlignment.MiddleRight
            style.Alignment = StringAlignment.Far
         Case ContentAlignment.MiddleCenter
            style.Alignment = StringAlignment.Center
      End Select
      
      ' Call the DrawString method of the System.Drawing class to write   
      ' text. Text and ClientRectangle are properties inherited from
      ' Control.
      e.Graphics.DrawString( _
          me.Text, _
          me.Font, _
          New SolidBrush(ForeColor), _
          RectangleF.op_Implicit(ClientRectangle), _
          style)

   End Sub

End Class

Utilisation du contrôle personnalisé dans un formulaire

L’exemple suivant montre un formulaire simple qui utilise FirstControl. Il crée trois instances de FirstControl, chacune présentant une valeur différente pour la propriété TextAlignment.

Pour compiler et exécuter cet exemple

1. Enregistrez le code de l’exemple suivant dans un fichier source (SimpleForm.cs ou SimpleForms.vb).

2. Compilez le code source dans un assembly exécutable en exécutant la commande suivante à partir du répertoire contenant le fichier source.

   vbc -r:CustomWinControls.dll -r:System.dll -r:System.Windows.Forms.dll -r:System.Drawing.dll SimpleForm.vb
   

   csc -r:CustomWinControls.dll -r:System.dll -r:System.Windows.Forms.dll -r:System.Drawing.dll SimpleForm.cs
   

   CustomWinControls.dll est l’assembly qui contient la classe FirstControl. Cet assembly doit se trouver dans le même répertoire que le fichier source pour le formulaire qui y accède (SimpleForm.cs ou SimpleForms.vb).

3. Exécutez SimpleForm.exe à l’aide de la commande suivante.

   SimpleForm
   

using System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;

namespace CustomWinControls
{

    public class SimpleForm : System.Windows.Forms.Form
    {
        private FirstControl firstControl1;

        private System.ComponentModel.Container components = null;

        public SimpleForm()
        {
            InitializeComponent();
        }

        protected override void Dispose( bool disposing )
        {
            if( disposing )
            {
                if (components != null)
                {
                    components.Dispose();
                }
            }
            base.Dispose( disposing );
        }

        private void InitializeComponent()
        {
            this.firstControl1 = new FirstControl();
            this.SuspendLayout();

            //
            // firstControl1
            //
            this.firstControl1.BackColor = System.Drawing.SystemColors.ControlDark;
            this.firstControl1.Location = new System.Drawing.Point(96, 104);
            this.firstControl1.Name = "firstControl1";
            this.firstControl1.Size = new System.Drawing.Size(75, 16);
            this.firstControl1.TabIndex = 0;
            this.firstControl1.Text = "Hello World";
            this.firstControl1.TextAlignment = System.Drawing.ContentAlignment.MiddleCenter;

            //
            // SimpleForm
            //
            this.ClientSize = new System.Drawing.Size(292, 266);
            this.Controls.Add(this.firstControl1);
            this.Name = "SimpleForm";
            this.Text = "SimpleForm";
            this.ResumeLayout(false);
        }

        [STAThread]
        static void Main()
        {
            Application.Run(new SimpleForm());
        }
    }
}

Imports System.Drawing
Imports System.Collections
Imports System.ComponentModel
Imports System.Windows.Forms




Public Class SimpleForm
   Inherits System.Windows.Forms.Form

   Private firstControl1 As FirstControl
   
   Private components As System.ComponentModel.Container = Nothing
   
   
   Public Sub New()
      InitializeComponent()
   End Sub 
   
   

   
   
   Private Sub InitializeComponent()
      Me.firstControl1 = New FirstControl()
      Me.SuspendLayout()
      
      ' 
      ' firstControl1
      ' 
      Me.firstControl1.BackColor = System.Drawing.SystemColors.ControlDark
      Me.firstControl1.Location = New System.Drawing.Point(96, 104)
      Me.firstControl1.Name = "firstControl1"
      Me.firstControl1.Size = New System.Drawing.Size(75, 16)
      Me.firstControl1.TabIndex = 0
      Me.firstControl1.Text = "Hello World"
      Me.firstControl1.TextAlignment = System.Drawing.ContentAlignment.MiddleCenter
      
      ' 
      ' SimpleForm
      ' 
      Me.ClientSize = New System.Drawing.Size(292, 266)
      Me.Controls.Add(firstControl1)
      Me.Name = "SimpleForm"
      Me.Text = "SimpleForm"
      Me.ResumeLayout(False)
   End Sub 
    
   
   <STAThread()>  _
   Shared Sub Main()
      Application.Run(New SimpleForm())
   End Sub 
End Class 

Voir aussi

• Propriétés dans les contrôles Windows Forms
• Événements dans les contrôles Windows Forms