KeyEventArgs Sınıf

  • Başvuru

Tanım

Ad Alanı:
System.Windows.Forms
Bütünleştirilmiş Kod:
System.Windows.Forms.dll

veya KeyUp olayı için KeyDown veri sağlar.

public ref class KeyEventArgs : EventArgs
[System.Runtime.InteropServices.ComVisible(true)]
public class KeyEventArgs : EventArgs
public class KeyEventArgs : EventArgs
[<System.Runtime.InteropServices.ComVisible(true)>]
type KeyEventArgs = class
    inherit EventArgs
type KeyEventArgs = class
    inherit EventArgs
Public Class KeyEventArgs
Inherits EventArgs
Devralma
Object
EventArgs
KeyEventArgs
Öznitelikler
ComVisibleAttribute

Örnekler

Aşağıdaki kod örnekleri, bir tuşa basma durumunun nasıl algı yapılacağını gösterir.

1. Örnek

Aşağıdaki kod örneği, uygulamanın kullanıcısına KeyDown açılır stil Yardımı'nı Help görüntülemek için sınıfıyla birlikte olayının nasıl kullanılacağını gösterir. Örnek, F1 tuşuna değiştirici anahtarla basmanın tüm çeşitlemelerini filtrelemek için olay işleyici yöntemine geçirilen özellikleri kullanır KeyEventArgs . Kullanıcı herhangi bir klavye değiştirici içeren herhangi bir F1 varyasyonu bastığında, sınıfı denetimin Help yanında bir benzeri bir ToolTipaçılır pencere görüntüler. Kullanıcı ALT+F2 tuşlarına basarsa, ek bilgiler içeren farklı bir Yardım açılır penceresi görüntülenir.

   // 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

Örnek 2

Aşağıdaki örnek, kullanıcının ALT+E tuşlarına basıp basmadığını ve fare işaretçisinin bir TreeNodeTreeNodeöğesinin üzerinde olup olmadığını belirler.

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( 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 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;
}

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 mouse 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

Örnek 3

Aşağıdaki örnek, kullanıcının sayısal olmayan bir tuşa basıp basmadığını belirler ve basıldıysa özelliğini kullanarak Handled olayı iptal ederKeyPress.

   // 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

Açıklamalar

KeyEventArgsKullanıcının bastığı tuşu ve aynı anda herhangi bir değiştirici tuşa (CTRL, ALT ve SHIFT) basılıp basılmadığını belirten bir , her KeyDown veya KeyUp olayla birlikte geçirilir.

Olay, KeyDown kullanıcı herhangi bir tuşa bastığında gerçekleşir. Olay, KeyUp kullanıcı anahtarı serbest bıraktığında gerçekleşir. Anahtar her yinelendiğinde yinelenen KeyDown olaylar gerçekleşir; anahtar tutulursa, ancak kullanıcı anahtarı serbest bıraktığında yalnızca bir KeyUp olay oluşturulur.

Olay KeyPress , bir tuşa basıldığında da gerçekleşir. Her KeyPress olayla birlikte bir KeyPressEventArgs geçirilir ve her tuşa basıldığında oluşturulan karakteri belirtir.

Olay modeli hakkında bilgi için bkz. Olayları İşleme ve Oluşturma.

Oluşturucular

KeyEventArgs(Keys)

KeyEventArgs sınıfının yeni bir örneğini başlatır.

Özellikler

Alt

ALT tuşuna basılıp basılmadığını gösteren bir değer alır.
Control

CTRL tuşuna basılıp basılmadığını belirten bir değer alır.
Handled

Olayın işlenip işlenmediğini belirten bir değer alır veya ayarlar.
KeyCode

Bir KeyDown veya KeyUp olayının klavye kodunu alır.
KeyData

Bir KeyDown veya KeyUp olayının anahtar verilerini alır.
KeyValue

Veya KeyDownKeyUp olayının klavye değerini alır.
Modifiers

Veya KeyDownKeyUp olayının değiştirici bayraklarını alır. Bayraklar hangi CTRL, SHIFT ve ALT tuşlarına basıldığını gösterir.
Shift

SHIFT tuşuna basılıp basılmadığını gösteren bir değer alır.
SuppressKeyPress

Anahtar olayının temel denetime geçirilip geçirilmeyeceğini belirten bir değer alır veya ayarlar.

Yöntemler

Equals(Object)

Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler.

(Devralındığı yer: Object)
GetHashCode()

Varsayılan karma işlevi işlevi görür.

(Devralındığı yer: Object)
GetType()

Type Geçerli örneğini alır.

(Devralındığı yer: Object)
MemberwiseClone()

Geçerli Objectöğesinin sığ bir kopyasını oluşturur.

(Devralındığı yer: Object)
ToString()

Geçerli nesneyi temsil eden dizeyi döndürür.

(Devralındığı yer: Object)

Şunlara uygulanır

Ayrıca bkz.