CODEWITHSUNDEEP
c#winformsaudiosystem-sounds
bendr
bendr

Reputation: 2475

Stop the 'Ding' when pressing Enter

I have a very simple Windows Forms Application. And, in Windows (or, atleast Windows Forms Applications), when you press Enter while inside a Single-line TextBox Control, you hear a Ding. It's an unpleasent sound, that indicated you cannot enter a newline, because it is a single-line TextBox.

This is all fine. However, in my Form, I have 1 TextBox, and a Search Button. And I am allowing the user to Perform a search by pressing Enter after they've finished typing, so they don't have to use the mouse to click the Search Button.

But this Ding sound occurs. It's very annoying.

How can we make it so just that sound doesn't play at all in my Form?

@David H - Here's how I'm detecting the enter pressing:

private void textBox1_KeyUp(object sender, KeyEventArgs e)
{
    if (e.KeyCode == Keys.Enter)
    {
        // Perform search now.
    }
}

Upvotes: 161

Views: 96450

Answers (18)

WvdHooven
WvdHooven

Reputation: 1

The e.SuppressKeyPress = True solution in the KeyDown event handler did not work for me since I have an Application.DoEvents() action called somewhere in the handler. (I know there is some hesitation using DoEvents(), but I could not find another solution)

I could eliminate the ding sound by just setting the TextBox.MultiLine property TextBox1.Multiline which allows the Enter key. Since the Enter key executes the handler, the user cannot enter multi-lines in this case anyway.

Upvotes: 0

Atrin Noori
Atrin Noori

Reputation: 341

I hope this would help:

Using KeyDown instead of KeyPress

private void AdvancedSearch_TXT_KeyDown(object sender, KeyEventArgs e)
        {
            if (e.KeyCode == Keys.Escape)
            {
                AdvancedSearch_TXT.Clear();
                e.SuppressKeyPress = true;
            }
        }

e.SupressKeyPress will do the trick

Upvotes: 1

synkro
synkro

Reputation: 457

Concerning the e.SuppressKeyPress = true; solution, it works fine by itself. Setting SuppressKeyPress to true also sets Handled to true, so there's no need to use e.Handled= true;

Upvotes: 0

Christian Fontaine
Christian Fontaine

Reputation: 13

i changed the textbox properties for an multiline textbox and it works for me.

Upvotes: 0

Shedrack Ikwabe
Shedrack Ikwabe

Reputation: 26

You can set your textbox multi-line to true then handle the Enter key press.

private void yourForm_Load(object sender, EventArgs e)
    {
        textBox1.Multiline = true;
    }

//then write your TextBox codes
private void textBox1_KeyUp(object sender, KeyEventArgs e)
{
    if (e.KeyCode == Keys.Enter)
    {
        // doSomething();
    }
}

Upvotes: 0

Berry Jansen
Berry Jansen

Reputation: 41

On WinForms the Enter key causes a Ding sound because the form property AcceptButton is not specified. If you don't need an AcceptButton the ding sound can be suppressed by setting the form KeyPreview to true and enter the following KeyPress event:

private void Form_KeyPress(object sender, KeyPressEventArgs e)
{
    if (e.KeyChar == '\r')
        e.Handled = true;
}

No matter what control is active, there will be no more ding sound when pressing the Enter key. Since the key event proccessing order is KeyDown, KeyPress and KeyUp the Enter key will still work for the KeyDown events for the controls.

Upvotes: 4

mdm
mdm

Reputation: 12630

Check out the Form.AcceptButton property. You can use it to specify a default button for a form, in this case for pressing enter.

From the docs:

This property enables you to designate a default action to occur when the user presses the ENTER key in your application. The button assigned to this property must be an IButtonControl that is on the current form or located within a container on the current form.

There is also a CancelButton property for when the user presses escape.

Upvotes: 67

brandonstrong
brandonstrong

Reputation: 698

Just add e.SuppressKeyPress = true; in your "if" statement.

private void textBox1_KeyUp(object sender, KeyEventArgs e)
{
    if (e.KeyCode == Keys.Enter)
    {
        //If true, do not pass the key event to the underlying control.
        e.SuppressKeyPress = true;  //This will suppress the "ding" sound.*/

        // Perform search now.
    }
}

Upvotes: 24

Snehasish
Snehasish

Reputation: 109

Use SuppressKeyPress to stop continued processing of the keystroke after handling it.

public class EntryForm: Form
{
   public EntryForm()
   {
   }

   private void EntryTextBox_KeyDown(object sender, KeyEventArgs e)
   {
      if(e.KeyCode == Keys.Enter)
      {
         e.Handled = true;
         e.SuppressKeyPress = true;
         // do some stuff

      }
      else if(e.KeyCode == Keys.Escape)
      {
          e.Handled = true;
          e.SuppressKeyPress = true;
          // do some stuff

      }
   }

   private void EntryTextBox_KeyUp(object sender, KeyEventArgs e)
   {
      if(e.KeyCode == Keys.Enter)
      {
         // do some stuff

      }
      else if(e.KeyCode == Keys.Escape)
      {
         // do some stuff

      }
   }
}

Upvotes: 10

ArtK
ArtK

Reputation: 1179

There is a very little chance anyone gets to this answer but some other answers are truly scary. Suppressing event on KeyDown kills 2 additional events in one strike. Setting e.Handled property to true is useless in this context.
The best way is to set Form.AcceptButton property to the actual Search Button.
There is also another way of utilizing Enter key - some people may want it to act as TAB button. To do that, add a new Button, set its Location property outside of the Form area (i.e. (-100, -100)) - setting Visible property to false may disable Button handlers in some cases. Set Form.AcceptButton property to your new button. In Click event handler add following code
this.SelectNextControl(ActiveControl, true, true, true, true)

Now, you may want to transfer focus only when focus it on TextBox you may want to either test ActiveControl type or use e.Supress property in event handlers of controls not meant to use Enter as TAB That's it. You don't even need to capture e.KeyCode

Upvotes: 2

user2793447
user2793447

Reputation: 315

Well I lived with this problem long enough and looked it up here.

After thinking about this for quite some time and wanting the simplest way to fix it I came up with the easiest but not so elegant way to fix it.

Here is what I did.

  1. Put 2 invisible buttons "Ok" and "Cancel" on the form.
  2. Set the AcceptButton and CancelButton Property on the form to the invisible buttons.
  3. Added no code to the buttons!

This solved all the secondary problems listed in this thread including the ToolStripMenu. My biggest complaint was the BindingNavigator, when I would enter a record number into the Current position to navigate to and pressed enter.

As per the original question in which the programmer wanted a search function when the enter button was pressed I simply put the search code in the invisible OK Button!

So far this seems to solve all problems but as we all know with Visual Studio, something will probably crop up.

The only other possible elegant way I could think of would be to write a new keystroke handling class which is way to much work for most of my projects.

Upvotes: 0

Mawardy
Mawardy

Reputation: 3838

You can Use KeyPress instead of KeyUp or KeyDown its more efficient and here's how to handle 

  private void textBox1_KeyPress(object sender, KeyPressEventArgs e)
    {
        if (e.KeyChar == (char)Keys.Enter)
        {
            e.Handled = true;
            button1.PerformClick();
        }
    }

and say peace to the 'Ding'

Upvotes: 17

Code.Town
Code.Town

Reputation: 1226

$("#txtSomething").keypress(function (e) {
        if (e.which == 13) {

            e.Handled = true; //This will prevent the "ding" sound

            //Write the rest of your code
        }
    });

Upvotes: 2

Lucio Fonseca
Lucio Fonseca

Reputation: 3527

It works for me:

private void textBox1_KeyDown(object sender, KeyEventArgs e)
{

    //Se apertou o enter
    if (e.KeyCode == Keys.Enter)
    {
        //enter key is down

        this.doSomething();

        e.Handled = true;
        e.SuppressKeyPress = true;

     }

 }

The SuppressKeyPress is the really trick. I hope that help you.

Upvotes: 256

Colin
Colin

Reputation: 168

I stumbled on this post while trying to handle a KeyDown this worked for me.

If e.KeyCode = Keys.Enter Then
   e.SuppressKeyPress = True
   btnLogIn.PerformClick()
End If

Supressing the Key Press stops the event from being sent to the underlying control. This should work if you're manually handling everything that the enter key will be doing within that textbox. Sorry about the Visual Basic.

Upvotes: 3

mahdi
mahdi

Reputation: 1

void RTextBox_KeyDown(object sender, KeyEventArgs e)
{
    if (e.KeyData == Keys.Enter)
    {
        //do ...
        bool temp = Multiline;
        Multiline = true;
        e.Handled = true;
        Multiline = temp;
    }
}

Upvotes: -2

FIre Panda
FIre Panda

Reputation: 6637

Try

textBox.KeyPress += new KeyPressEventHandler(keypressed);

private void keypressed(Object o, KeyPressEventArgs e)
{
    if (e.KeyCode == Keys.Enter)
    {
        e.Handled = true; //this line will do the trick
    }
}

Upvotes: 63

Zruty
Zruty

Reputation: 8687

Set your Search button's IsDefault property to true. This will make it a default button and it will be auto-clicked when Enter is pressed.

Upvotes: 0

Related Questions