Guide pratique pour modifier l'entrée au clavier pour un contrôle standard

Article
06/02/2023

Windows Forms offre la possibilité de consommer et de modifier l'entrée au clavier. Consommer une touche signifie gérer une touche dans une méthode ou un gestionnaire d'événements pour que d'autres méthodes et événements plus loin dans la file d'attente de messages ne reçoivent pas la valeur de la touche. Modifier une touche signifie modifier sa valeur pour que les méthodes et les gestionnaires d'événements plus loin dans la file d'attente de messages reçoivent une valeur de touche différente. Cette rubrique montre comment accomplir ces tâches.

Pour consommer une touche

Dans un gestionnaire d'événements KeyPress, affectez la valeur true à la propriété Handled de la classe KeyPressEventArgs.

-ou-

Dans un gestionnaire d'événements KeyDown, affectez la valeur true à la propriété Handled de la classe KeyEventArgs.

Remarque

La définition de la propriété Handled dans le gestionnaire d'événements KeyDown n'empêche pas les événements KeyPress et KeyUp d'être déclenchés pour la séquence de touches actuelle. Vous devez pour cela utiliser la propriété SuppressKeyPress.

L'exemple suivant est un extrait d'instruction switch qui examine la propriété KeyChar du KeyPressEventArgs reçu par un gestionnaire d'événements KeyPress. Ce code consomme les touches de caractère « A » et « a ».
```
// Consume 'A' and 'a'.
case (char)65:
case (char)97:
    MessageBox.Show("Control.KeyPress: '" +
        e.KeyChar.ToString() + "' consumed.");
    e.Handled = true;
    break;
```
```
' Consume 'A' and 'a'.
Case ChrW(65), ChrW(97)
    MessageBox.Show(("Control.KeyPress: '" + _
        e.KeyChar.ToString() + "' consumed."))
    e.Handled = True
```

Pour modifier une touche de caractère standard

Dans un gestionnaire d'événements KeyPress, affectez à la propriété KeyChar de la classe KeyPressEventArgs la valeur de la nouvelle touche de caractère.

L'exemple suivant est un extrait d'instruction switch qui remplace « B » par « A » et « b » par « a ». Notez que la propriété Handled du paramètre KeyPressEventArgs a la valeur false, pour que la nouvelle valeur de touche soit propagée aux autres méthodes et événements dans la file d'attente de messages.

// Detect 'B', modify it to 'A', and forward the key.
case (char)66:
    MessageBox.Show("Control.KeyPress: '" +
        e.KeyChar.ToString() + "' replaced by 'A'.");
    e.KeyChar = (char)65;
    e.Handled = false;
    break;

// Detect 'b', modify it to 'a', and forward the key.
case (char)98:
    MessageBox.Show("Control.KeyPress: '" +
        e.KeyChar.ToString() + "' replaced by 'a'.");
    e.KeyChar = (char)97;
    e.Handled = false;
    break;

    ' Modify 'B' to 'A' and forward the key.
Case ChrW(66)
    MessageBox.Show(("Control.KeyPress: '" + _
        e.KeyChar.ToString() + "' replaced by 'A'."))
    e.KeyChar = ChrW(65)
    e.Handled = False

    ' Modify 'b' to 'a' and forward the key.
Case ChrW(98)
    MessageBox.Show(("Control.KeyPress: '" + _
        e.KeyChar.ToString() + "' replaced by 'a'."))
    e.KeyChar = ChrW(97)
    e.Handled = False

Pour modifier une touche non-caractère

Substituez une méthode Control qui traite les messages Windows, détectez le message WM_KEYDOWN ou WM_SYSKEYDOWN et affectez à la propriété WParam du paramètre Message la valeur Keys qui représente la nouvelle touche non-caractère.

L'exemple de code suivant montre comment substituer la méthode PreProcessMessage d'un contrôle pour détecter les touches F1 à F9 et modifier toute activation de la touche F3 en F1. Pour plus d’informations sur les Control méthodes que vous pouvez remplacer pour intercepter les messages clavier, consultez Entrée utilisateur dans une application Windows Forms et fonctionnement de l’entrée du clavier.

// Detect F1 through F9 during preprocessing and modify F3.
public override bool PreProcessMessage(ref Message m)
{
    if (m.Msg == WM_KEYDOWN)
    {
        Keys keyCode = (Keys)m.WParam & Keys.KeyCode;

        // Detect F1 through F9.
        switch (keyCode)
        {
            case Keys.F1:
            case Keys.F2:
            case Keys.F3:
            case Keys.F4:
            case Keys.F5:
            case Keys.F6:
            case Keys.F7:
            case Keys.F8:
            case Keys.F9:

                MessageBox.Show("Control.PreProcessMessage: '" +
                  keyCode.ToString() + "' pressed.");

                // Replace F3 with F1, so that ProcessKeyMessage will
                // receive F1 instead of F3.
                if (keyCode == Keys.F3)
                {
                    m.WParam = (IntPtr)Keys.F1;
                    MessageBox.Show("Control.PreProcessMessage: '" +
                        keyCode.ToString() + "' replaced by F1.");
                }
                break;
        }
    }

    // Send all other messages to the base method.
    return base.PreProcessMessage(ref m);
}

' Detect F1 through F9 during preprocessing and modify F3.
Public Overrides Function PreProcessMessage(ByRef m As Message) _
    As Boolean

    If m.Msg = WM_KEYDOWN Then
        Dim keyCode As Keys = CType(m.WParam, Keys) And Keys.KeyCode

        ' Detect F1 through F9.
        Select Case keyCode
            Case Keys.F1, Keys.F2, Keys.F3, Keys.F4, Keys.F5, _
                 Keys.F6, Keys.F7, Keys.F8, Keys.F9

                MessageBox.Show(("Control.PreProcessMessage: '" + _
                    keyCode.ToString() + "' pressed."))

                ' Replace F3 with F1, so that ProcessKeyMessage will  
                ' receive F1 instead of F3.
                If keyCode = Keys.F3 Then
                    m.WParam = CType(Keys.F1, IntPtr)
                    MessageBox.Show(("Control.PreProcessMessage: '" + _
                        keyCode.ToString() + "' replaced by F1."))
                End If
        End Select
    End If

    ' Send all other messages to the base method.
    Return MyBase.PreProcessMessage(m)
End Function

Exemple

L'exemple de code suivant est l'application complète pour les exemples de code des sections précédentes. L'application utilise un contrôle personnalisé dérivé de la classe TextBox pour consommer et modifier l'entrée au clavier.

using System;
using System.Drawing;
using System.Windows.Forms;

namespace KeyboardInput
{
    class Form1 : Form
    {
        // The following Windows message value is defined in Winuser.h.
        private int WM_KEYDOWN = 0x100;
        CustomTextBox CustomTextBox1 = new CustomTextBox();

        [STAThread]
        public static void Main()
        {
            Application.EnableVisualStyles();
            Application.Run(new Form1());
        }

        public Form1()
        {
            this.AutoSize = true;
            this.Controls.Add(CustomTextBox1);
            CustomTextBox1.KeyPress +=
                new KeyPressEventHandler(CustomTextBox1_KeyPress);
        }

        // Consume and modify several character keys.
        void CustomTextBox1_KeyPress(object sender, KeyPressEventArgs e)
        {
            switch (e.KeyChar)
            {
                // Consume 'A' and 'a'.
                case (char)65:
                case (char)97:
                    MessageBox.Show("Control.KeyPress: '" +
                        e.KeyChar.ToString() + "' consumed.");
                    e.Handled = true;
                    break;

                // Detect 'B', modify it to 'A', and forward the key.
                case (char)66:
                    MessageBox.Show("Control.KeyPress: '" +
                        e.KeyChar.ToString() + "' replaced by 'A'.");
                    e.KeyChar = (char)65;
                    e.Handled = false;
                    break;

                // Detect 'b', modify it to 'a', and forward the key.
                case (char)98:
                    MessageBox.Show("Control.KeyPress: '" +
                        e.KeyChar.ToString() + "' replaced by 'a'.");
                    e.KeyChar = (char)97;
                    e.Handled = false;
                    break;
            }
        }
    }
    
    public class CustomTextBox : TextBox
    {
        // The following Windows message value is defined in Winuser.h.
        private int WM_KEYDOWN = 0x100;

        public CustomTextBox()
        {
            this.Size = new Size(100, 100);
            this.AutoSize = false;
        }

        // Detect F1 through F9 during preprocessing and modify F3.
        public override bool PreProcessMessage(ref Message m)
        {
            if (m.Msg == WM_KEYDOWN)
            {
                Keys keyCode = (Keys)m.WParam & Keys.KeyCode;

                // Detect F1 through F9.
                switch (keyCode)
                {
                    case Keys.F1:
                    case Keys.F2:
                    case Keys.F3:
                    case Keys.F4:
                    case Keys.F5:
                    case Keys.F6:
                    case Keys.F7:
                    case Keys.F8:
                    case Keys.F9:

                        MessageBox.Show("Control.PreProcessMessage: '" +
                          keyCode.ToString() + "' pressed.");

                        // Replace F3 with F1, so that ProcessKeyMessage will
                        // receive F1 instead of F3.
                        if (keyCode == Keys.F3)
                        {
                            m.WParam = (IntPtr)Keys.F1;
                            MessageBox.Show("Control.PreProcessMessage: '" +
                                keyCode.ToString() + "' replaced by F1.");
                        }
                        break;
                }
            }

            // Send all other messages to the base method.
            return base.PreProcessMessage(ref m);
        }

        // Detect F1 through F9 during processing.
        protected override bool ProcessKeyMessage(ref Message m)
        {
            if (m.Msg == WM_KEYDOWN)
            {
                Keys keyCode = (Keys)m.WParam & Keys.KeyCode;

                // Detect F1 through F9.
                switch (keyCode)
                {
                    case Keys.F1:
                    case Keys.F2:
                    case Keys.F3:
                    case Keys.F4:
                    case Keys.F5:
                    case Keys.F6:
                    case Keys.F7:
                    case Keys.F8:
                    case Keys.F9:

                        MessageBox.Show("Control.ProcessKeyMessage: '" +
                          keyCode.ToString() + "' pressed.");
                        break;
                }
            }

            // Send all messages to the base method.
            return base.ProcessKeyMessage(ref m);
        }
    }
}

Imports System.Drawing
Imports System.Security
Imports System.Security.Permissions
Imports System.Windows.Forms

Namespace KeyboardInput
    Class Form1
        Inherits Form

        ' The following Windows message value is defined in Winuser.h.
        Private WM_KEYDOWN As Integer = &H100
        Private WithEvents CustomTextBox1 As New CustomTextBox()

        <STAThread()> _
        Public Shared Sub Main()
            Application.EnableVisualStyles()
            Application.Run(New Form1())
        End Sub

        Public Sub New()
            Me.AutoSize = True
            Me.Controls.Add(CustomTextBox1)
        End Sub

        ' Consume and modify several character keys.
        Sub CustomTextBox1_KeyPress(ByVal sender As Object, _
            ByVal e As KeyPressEventArgs) Handles CustomTextBox1.KeyPress

            Select Case e.KeyChar

                ' Consume 'A' and 'a'.
                Case ChrW(65), ChrW(97)
                    MessageBox.Show(("Control.KeyPress: '" + _
                        e.KeyChar.ToString() + "' consumed."))
                    e.Handled = True

                    ' Modify 'B' to 'A' and forward the key.
                Case ChrW(66)
                    MessageBox.Show(("Control.KeyPress: '" + _
                        e.KeyChar.ToString() + "' replaced by 'A'."))
                    e.KeyChar = ChrW(65)
                    e.Handled = False

                    ' Modify 'b' to 'a' and forward the key.
                Case ChrW(98)
                    MessageBox.Show(("Control.KeyPress: '" + _
                        e.KeyChar.ToString() + "' replaced by 'a'."))
                    e.KeyChar = ChrW(97)
                    e.Handled = False
            End Select
        End Sub
    End Class

    Public Class CustomTextBox
        Inherits TextBox

        ' The following Windows message value is defined in Winuser.h.
        Private WM_KEYDOWN As Integer = &H100

        Public Sub New()
            Me.Size = New Size(100, 100)
            Me.AutoSize = False
        End Sub

        ' Detect F1 through F9 during preprocessing and modify F3.
        Public Overrides Function PreProcessMessage(ByRef m As Message) _
            As Boolean

            If m.Msg = WM_KEYDOWN Then
                Dim keyCode As Keys = CType(m.WParam, Keys) And Keys.KeyCode

                ' Detect F1 through F9.
                Select Case keyCode
                    Case Keys.F1, Keys.F2, Keys.F3, Keys.F4, Keys.F5, _
                         Keys.F6, Keys.F7, Keys.F8, Keys.F9

                        MessageBox.Show(("Control.PreProcessMessage: '" + _
                            keyCode.ToString() + "' pressed."))

                        ' Replace F3 with F1, so that ProcessKeyMessage will  
                        ' receive F1 instead of F3.
                        If keyCode = Keys.F3 Then
                            m.WParam = CType(Keys.F1, IntPtr)
                            MessageBox.Show(("Control.PreProcessMessage: '" + _
                                keyCode.ToString() + "' replaced by F1."))
                        End If
                End Select
            End If

            ' Send all other messages to the base method.
            Return MyBase.PreProcessMessage(m)
        End Function

        ' Detect F1 through F9 during processing.
        Protected Overrides Function ProcessKeyMessage(ByRef m As Message) _
            As Boolean

            If m.Msg = WM_KEYDOWN Then
                Dim keyCode As Keys = CType(m.WParam, Keys) And Keys.KeyCode

                ' Detect F1 through F9.
                Select Case keyCode
                    Case Keys.F1, Keys.F2, Keys.F3, Keys.F4, Keys.F5, _
                         Keys.F6, Keys.F7, Keys.F8, Keys.F9

                        MessageBox.Show(("Control.ProcessKeyMessage: '" + _
                            keyCode.ToString() + "' pressed."))
                End Select
            End If

            ' Send all messages to the base method.
            Return MyBase.ProcessKeyMessage(m)
        End Function

    End Class
End Namespace

Compilation du code

Cet exemple nécessite :

des références aux assemblys System, System.Drawing et System.Windows.Forms.

Partager via