KeyEventArgs Classe

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

KeyEventArgs.cs

Fournit des données pour l'événement KeyDown ou KeyUp.

C#

public class KeyEventArgs : EventArgs

Héritage

Object

EventArgs

KeyEventArgs

Exemples

Les exemples de code suivants montrent comment détecter l’état d’un appui sur une touche.

Exemple 1

L’exemple de code suivant montre comment utiliser l’événement KeyDown avec la Help classe pour afficher le style pop-up Help à l’utilisateur de l’application. L’exemple utilise les KeyEventArgs propriétés passées à la méthode de gestionnaire d’événements pour filtrer toutes les variantes d’appui sur la touche F1 avec une touche modificateur. Lorsque l’utilisateur appuie sur une variante de F1 qui inclut un modificateur de clavier, la Help classe affiche une fenêtre contextuelle, similaire à un ToolTip, près du contrôle. Si l’utilisateur appuie sur ALT+F2, une autre fenêtre contextuelle d’aide s’affiche avec des informations supplémentaires.

C#

private void textBox1_KeyDown(object sender, System.Windows.Forms.KeyEventArgs e)
{
    // Determine whether the key entered is the F1 key. If it is, display Help.
    if(e.KeyCode == Keys.F1 && (e.Alt || e.Control || e.Shift))
    {
        // Display a pop-up Help topic to assist the user.
        Help.ShowPopup(textBox1, "Enter your name.", new Point(textBox1.Bottom, textBox1.Right));
    }
    else if(e.KeyCode == Keys.F2 && e.Modifiers == Keys.Alt)
    {
        // Display a pop-up Help topic to provide additional assistance to the user.
        Help.ShowPopup(textBox1, "Enter your first name followed by your last name. Middle name is optional.",
            new Point(textBox1.Top, this.textBox1.Left));
    }
}

Exemple 2

L’exemple suivant détermine si l’utilisateur a appuyé sur ALT+E et si le pointeur de la souris se trouve sur un TreeNode, permet à l’utilisateur de modifier ce .TreeNode

C#

private void treeView1_KeyDown(object sender, KeyEventArgs e)
{
   /* If the 'Alt' and 'E' keys are pressed,
      * allow the user to edit the TreeNode label. */
   if(e.Alt && e.KeyCode == Keys.E)
         
   {
      treeView1.LabelEdit = true;
      // If there is a TreeNode under the mouse cursor, begin editing. 
      TreeNode editNode = treeView1.GetNodeAt(
         treeView1.PointToClient(System.Windows.Forms.Control.MousePosition));
      if(editNode != null)
      { 
         editNode.BeginEdit();
      }
   }
}

private void treeView1_AfterLabelEdit(object sender, NodeLabelEditEventArgs e)
{
   // Disable the ability to edit the TreeNode labels.
   treeView1.LabelEdit = false;
}

Exemple 3

L’exemple suivant détermine si l’utilisateur a appuyé sur une touche non numérique et, le cas échéant, annule l’événement à l’aide KeyPress de la Handled propriété .

C#

// Boolean flag used to determine when a character other than a number is entered.
private bool nonNumberEntered = false;

// Handle the KeyDown event to determine the type of character entered into the control.
private void textBox1_KeyDown(object sender, System.Windows.Forms.KeyEventArgs e)
{
    // Initialize the flag to false.
    nonNumberEntered = false;

    // Determine whether the keystroke is a number from the top of the keyboard.
    if (e.KeyCode < Keys.D0 || e.KeyCode > Keys.D9)
    {
        // Determine whether the keystroke is a number from the keypad.
        if (e.KeyCode < Keys.NumPad0 || e.KeyCode > Keys.NumPad9)
        {
            // Determine whether the keystroke is a backspace.
            if(e.KeyCode != Keys.Back)
            {
                // A non-numerical keystroke was pressed.
                // Set the flag to true and evaluate in KeyPress event.
                nonNumberEntered = true;
            }
        }
    }
    //If shift key was pressed, it's not a number.
    if (Control.ModifierKeys == Keys.Shift) {
        nonNumberEntered = true;
    }
}

// This event occurs after the KeyDown event and can be used to prevent
// characters from entering the control.
private void textBox1_KeyPress(object sender, System.Windows.Forms.KeyPressEventArgs e)
{
    // Check for the flag being set in the KeyDown event.
    if (nonNumberEntered)
    {
        // Stop the character from being entered into the control since it is non-numerical.
        e.Handled = true;
    }
}

Remarques

, KeyEventArgsqui spécifie la touche enfoncée par l’utilisateur et si des touches de modificateur (Ctrl, Alt et Maj) ont été enfoncées en même temps, est passé avec chaque KeyDown événement ou KeyUp .

L’événement KeyDown se produit lorsque l’utilisateur appuie sur une touche. L’événement KeyUp se produit lorsque l’utilisateur libère la clé. Des événements dupliqués KeyDown se produisent chaque fois que la clé se répète, si la clé est arrêtée, mais qu’un KeyUp seul événement est généré lorsque l’utilisateur libère la clé.

L’événement KeyPress se produit également lorsqu’une touche est enfoncée. Un KeyPressEventArgs est passé avec chaque KeyPress événement et spécifie le caractère qui a été composé à la suite de chaque appui sur la touche.

Pour plus d’informations sur le modèle d’événement, consultez Gestion et déclenchement d’événements.

Constructeurs

KeyEventArgs(Keys)

Initialise une nouvelle instance de la classe KeyEventArgs.

Propriétés

Alt	Obtient une valeur indiquant si la touche Alt a été activée.
Control	Obtient une valeur indiquant si la touche Ctrl a été activée.
Handled	Obtient ou définit une valeur indiquant si l'événement a été géré.
KeyCode	Obtient le code de clavier d'un événement KeyDown ou KeyUp.
KeyData	Obtient les données de touches d'un événement KeyDown ou KeyUp.
KeyValue	Obtient la valeur de clavier d'un événement KeyDown ou KeyUp.
Modifiers	Obtient les indicateurs de touches de modification d'un événement KeyDown ou KeyUp. Les indicateurs indiquent la combinaison de touches Ctrl, Maj et Alt activée.
Shift	Obtient une valeur indiquant si la touche Maj a été activée.
SuppressKeyPress	Obtient ou définit une valeur indiquant si l'événement de touche doit être transmis au contrôle sous-jacent.

S’applique à

Voir aussi

• OnKeyDown(KeyEventArgs)
• KeyDown
• OnKeyUp(KeyEventArgs)
• KeyUp
• KeyPressEventArgs
• OnKeyPress(KeyPressEventArgs)
• KeyPress