KeyEventArgs Класс

Определение

Предоставляет данные для события KeyDown или KeyUp.Provides data for the KeyDown or KeyUp event.

public ref class KeyEventArgs : EventArgs
[System.Runtime.InteropServices.ComVisible(true)]
public class KeyEventArgs : EventArgs
type KeyEventArgs = class
    inherit EventArgs
Public Class KeyEventArgs
Inherits EventArgs
Наследование
KeyEventArgs
Атрибуты

Примеры

В следующих примерах кода показано, как определить состояние нажатия клавиши.The following code examples demonstrate how to detect the state of a key press.

Пример 1Example 1

В следующем примере кода показано, как использовать KeyDown событие Help с классом для отображения всплывающего стиля справки для пользователя приложения.The following code example demonstrates how to use the KeyDown event with the Help class to display pop-up style Help to the user of the application. В примере используются свойства KeyEventArgs , передаваемые в метод обработчика событий для фильтрации всех вариантов нажатия клавиши F1 с помощью клавиши-модификатора.The example uses the KeyEventArgs properties passed to the event handler method to filter for all variations of pressing the F1 key with a modifier key. Когда пользователь нажимает любой вариант F1, включающий любой модификатор клавиатуры, Help класс отображает всплывающее окно, аналогичное ToolTipэлементу управления рядом с элементом.When the user presses any variation of F1 that includes any keyboard modifier, the Help class displays a pop-up window, similar to a ToolTip, near the control. Если пользователь нажимает ALT + F2, отображается другое всплывающее окно справки с дополнительными сведениями.If the user presses ALT+F2, a different Help pop-up is displayed with additional information.

   // This example demonstrates how to use the KeyDown event with the Help class to display
   // pop-up style help to the user of the application. The example filters for all variations
   // of pressing the F1 key with a modifier key by using the KeyEventArgs properties passed
   // to the event handling method.
   // When the user presses any variation of F1 that includes any keyboard modifier, the Help
   // class displays a pop-up window, similar to a ToolTip, near the control. If the user presses
   // ALT + F2, a different Help pop-up is displayed with additional information. This example assumes
   // that a tTextBox control, named textBox1, has been added to the form and its KeyDown
   // event has been contected to this event handling method.
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.", 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.",
            Point(textBox1->Top,this->textBox1->Left) );
      }
   }
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));
    }
}
Private Sub textBox1_KeyDown(ByVal sender As Object, ByVal e As System.Windows.Forms.KeyEventArgs) Handles textBox1.KeyDown
    ' Determine whether the key entered is the F1 key. If it is, display Help.
    If e.KeyCode = Keys.F1 AndAlso (e.Alt OrElse e.Control OrElse e.Shift) Then
        ' Display a pop-up Help topic to assist the user.
        Help.ShowPopup(textBox1, "Enter your name.", New Point(textBox1.Bottom, textBox1.Right))
    ElseIf e.KeyCode = Keys.F2 AndAlso e.Modifiers = Keys.Alt Then
        ' 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, Me.textBox1.Left))
    End If
End Sub

Пример 2Example 2

В следующем примере определяется, нажал ли пользователь Alt + E, и если указатель мыши находится над TreeNode, пользователь может изменить его. TreeNodeThe following example determines whether the user pressed ALT+E, and if the mouse pointer is over a TreeNode, allows the user to edit that TreeNode.

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 mose cursor, begin editing.
         TreeNode^ editNode = treeView1->GetNodeAt( treeView1->PointToClient( Control::MousePosition ) );
         if ( editNode != nullptr )
         {
            editNode->BeginEdit();
         }
      }
   }

   void treeView1_AfterLabelEdit( Object^ /*sender*/, NodeLabelEditEventArgs^ /*e*/ )
   {
      // Disable the ability to edit the TreeNode labels.
      treeView1->LabelEdit = false;
   }
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 mose 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;
}
Private Sub treeView1_KeyDown(sender As Object, _
  e As KeyEventArgs) Handles treeView1.KeyDown
   ' If the 'Alt' and 'E' keys are pressed,
   ' allow the user to edit the TreeNode label. 
   If e.Alt And e.KeyCode = Keys.E Then
      treeView1.LabelEdit = True
      ' If there is a TreeNode under the mose cursor, begin editing. 
      Dim editNode As TreeNode = treeView1.GetNodeAt( _
        treeView1.PointToClient(System.Windows.Forms.Control.MousePosition))
      If (editNode IsNot Nothing) Then
         editNode.BeginEdit()
      End If
   End If
End Sub

Private Sub treeView1_AfterLabelEdit(sender As Object, _
  e As NodeLabelEditEventArgs) Handles treeView1.AfterLabelEdit
   ' Disable the ability to edit the TreeNode labels.
   treeView1.LabelEdit = False
End Sub

Пример 3Example 3

В следующем примере определяется, нажал ли пользователь нечисловой ключ, и, если да, отменяет KeyPress событие с Handled помощью свойства.The following example determines whether the user pressed a non-numeric key, and if so, cancels the KeyPress event by using the Handled property.

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

   // Handle the KeyDown event to determine the type of character entered into the control.
   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.
   void textBox1_KeyPress( Object^ /*sender*/, System::Windows::Forms::KeyPressEventArgs^ e )
   {
      // Check for the flag being set in the KeyDown event.
      if ( nonNumberEntered == true )
      {         // Stop the character from being entered into the control since it is non-numerical.
         e->Handled = true;
      }
   }
// 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 == true)
    {
        // Stop the character from being entered into the control since it is non-numerical.
        e.Handled = true;
    }
}

 ' Boolean flag used to determine when a character other than a number is entered.
 Private nonNumberEntered As Boolean = False


 ' Handle the KeyDown event to determine the type of character entered into the control.
 Private Sub textBox1_KeyDown(sender As Object, e As System.Windows.Forms.KeyEventArgs) _
      Handles textBox1.KeyDown
     ' 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 OrElse e.KeyCode > Keys.D9 Then
         ' Determine whether the keystroke is a number from the keypad.
         If e.KeyCode < Keys.NumPad0 OrElse e.KeyCode > Keys.NumPad9 Then
             ' Determine whether the keystroke is a backspace.
             If e.KeyCode <> Keys.Back Then
                 ' A non-numerical keystroke was pressed. 
                 ' Set the flag to true and evaluate in KeyPress event.
                 nonNumberEntered = True
             End If
         End If
     End If
     'If shift key was pressed, it's not a number.
     If Control.ModifierKeys = Keys.Shift Then
         nonNumberEntered = true
     End If
 End Sub


 ' This event occurs after the KeyDown event and can be used 
 ' to prevent characters from entering the control.
 Private Sub textBox1_KeyPress(sender As Object, e As System.Windows.Forms.KeyPressEventArgs) _
     Handles textBox1.KeyPress
     ' Check for the flag being set in the KeyDown event.
     If nonNumberEntered = True Then
         ' Stop the character from being entered into the control since it is non-numerical.
         e.Handled = True
     End If
 End Sub

Комментарии

Объект KeyEventArgs, указывающий клавишу, которую пользователь нажал и какие клавиши-модификаторы (Ctrl, Alt и Shift) были нажаты одновременно, передается с каждым KeyDown событием KeyUp или.A KeyEventArgs, which specifies the key the user pressed and whether any modifier keys (CTRL, ALT, and SHIFT) were pressed at the same time, is passed with each KeyDown or KeyUp event.

Это KeyDown событие возникает при нажатии пользователем любого ключа.The KeyDown event occurs when the user presses any key. Это KeyUp событие возникает, когда пользователь отпускает ключ.The KeyUp event occurs when the user releases the key. Повторяющиеся KeyDown события происходят при каждом повторении ключа, если ключ удерживается, но при освобождении ключа KeyUp создается только одно событие.Duplicate KeyDown events occur each time the key repeats, if the key is held down, but only one KeyUp event is generated when the user releases the key.

Это KeyPress событие также возникает при нажатии клавиши.The KeyPress event also occurs when a key is pressed. Объект KeyPressEventArgs передается с KeyPress каждым событием и указывает символ, состоящий из результатов каждого нажатия клавиши.A KeyPressEventArgs is passed with each KeyPress event, and specifies the character that was composed as a result of each key press.

Дополнительные сведения о модели событий см. в разделе обработка и вызов событий.For information about the event model, see Handling and Raising Events.

Конструкторы

KeyEventArgs(Keys)

Инициализирует новый экземпляр класса KeyEventArgs.Initializes a new instance of the KeyEventArgs class.

Свойства

Alt

Получает значение, показывающее, была ли нажата клавиша ALT.Gets a value indicating whether the ALT key was pressed.

Control

Получает значение, показывающее, была ли нажата клавиша CTRL.Gets a value indicating whether the CTRL key was pressed.

Handled

Получает или задает значение, определяющее, было ли обработано событие.Gets or sets a value indicating whether the event was handled.

KeyCode

Получает код клавиатуры для события KeyDown или события KeyUp.Gets the keyboard code for a KeyDown or KeyUp event.

KeyData

Получает данные, касающиеся клавиши, для события KeyDown или KeyUp.Gets the key data for a KeyDown or KeyUp event.

KeyValue

Получает значение клавиатуры для события KeyDown или KeyUp.Gets the keyboard value for a KeyDown or KeyUp event.

Modifiers

Получает флаги модификаторов для события KeyDown или события KeyUp.Gets the modifier flags for a KeyDown or KeyUp event. Флаги указывают, какая комбинация клавиш CTRL, SHIFT и ALT была нажата.The flags indicate which combination of CTRL, SHIFT, and ALT keys was pressed.

Shift

Получает значение, показывающее, была ли нажата клавиша SHIFT.Gets a value indicating whether the SHIFT key was pressed.

SuppressKeyPress

Получает или задает значение, указывающее, следует ли передавать события нажатия клавиши базовому элементу управления.Gets or sets a value indicating whether the key event should be passed on to the underlying control.

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к

Дополнительно