Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Form.AcceptButton Property

Gets or sets the button on the form that is clicked when the user presses the ENTER key.

[Visual Basic]
Public Property AcceptButton As IButtonControl
[C#]
public IButtonControl AcceptButton {get; set;}
[C++]
public: __property IButtonControl* get_AcceptButton();
public: __property void set_AcceptButton(IButtonControl*);
[JScript]
public function get AcceptButton() : IButtonControl;
public function set AcceptButton(IButtonControl);

Property Value

An IButtonControl that represents the button to use as the accept button for the form.

Remarks

This property allows 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.

You can use this property to allow the user to quickly navigate a simple form by allowing them to simply press the ENTER key when they are finished instead of manually clicking the accept button with their mouse.

The accept button might not be activated if the currently selected control on the form intercepts the ENTER key and processes it. For example, a multiline text box control allows the ENTER key to be pressed when it is selected to insert a new line character in the control.

Example

[Visual Basic, C#, C++] The following example creates a new instance of a Form and calls the ShowDialog method to display the form as a dialog box. The example sets the FormBorderStyle, AcceptButton, CancelButton, MinimizeBox, MaximizeBox, and StartPosition properties to change the appearance and functionality of the form to a dialog box. The example also uses the Add method of the form's Controls collection to add two Button controls. The example uses the HelpButton property to display a help button in the caption bar of the dialog box.

[Visual Basic] 
Public Sub CreateMyForm()
    ' Create a new instance of the form.
    Dim form1 As New Form()
    ' Create two buttons to use as the accept and cancel buttons.
    Dim button1 As New Button()
    Dim button2 As New Button()
       
    ' Set the text of button1 to "OK".
    button1.Text = "OK"
    ' Set the position of the button on the form.
    button1.Location = New Point(10, 10)
    ' Set the text of button2 to "Cancel".
    button2.Text = "Cancel"
    ' Set the position of the button based on the location of button1.
    button2.Location = _
       New Point(button1.Left, button1.Height + button1.Top + 10)
    ' Set the caption bar text of the form.   
    form1.Text = "My Dialog Box"
    ' Display a help button on the form.
    form1.HelpButton = True
       
    ' Define the border style of the form to a dialog box.
    form1.FormBorderStyle = FormBorderStyle.FixedDialog
    ' Set the MaximizeBox to false to remove the maximize box.
    form1.MaximizeBox = False
    ' Set the MinimizeBox to false to remove the minimize box.
    form1.MinimizeBox = False
    ' Set the accept button of the form to button1.
    form1.AcceptButton = button1
    ' Set the cancel button of the form to button2.
    form1.CancelButton = button2
    ' Set the start position of the form to the center of the screen.
    form1.StartPosition = FormStartPosition.CenterScreen
       
    ' Add button1 to the form.
    form1.Controls.Add(button1)
    ' Add button2 to the form.
    form1.Controls.Add(button2)
       
    ' Display the form as a modal dialog box.
    form1.ShowDialog()
End Sub

[C#] 
public void CreateMyForm()
{
   // Create a new instance of the form.
   Form form1 = new Form();
   // Create two buttons to use as the accept and cancel buttons.
   Button button1 = new Button ();
   Button button2 = new Button ();
  
   // Set the text of button1 to "OK".
   button1.Text = "OK";
   // Set the position of the button on the form.
   button1.Location = new Point (10, 10);
   // Set the text of button2 to "Cancel".
   button2.Text = "Cancel";
   // Set the position of the button based on the location of button1.
   button2.Location
      = new Point (button1.Left, button1.Height + button1.Top + 10);
   // Set the caption bar text of the form.   
   form1.Text = "My Dialog Box";
   // Display a help button on the form.
   form1.HelpButton = true;

   // Define the border style of the form to a dialog box.
   form1.FormBorderStyle = FormBorderStyle.FixedDialog;
   // Set the MaximizeBox to false to remove the maximize box.
   form1.MaximizeBox = false;
   // Set the MinimizeBox to false to remove the minimize box.
   form1.MinimizeBox = false;
   // Set the accept button of the form to button1.
   form1.AcceptButton = button1;
   // Set the cancel button of the form to button2.
   form1.CancelButton = button2;
   // Set the start position of the form to the center of the screen.
   form1.StartPosition = FormStartPosition.CenterScreen;
   
   // Add button1 to the form.
   form1.Controls.Add(button1);
   // Add button2 to the form.
   form1.Controls.Add(button2);
   
   // Display the form as a modal dialog box.
   form1.ShowDialog();
}

[C++] 
public:
 void CreateMyForm()
 {
    // Create a new instance of the form.
    Form* form1 = new Form();
    // Create two buttons to use as the accept and cancel buttons.
    Button* button1 = new Button ();
    Button* button2 = new Button ();
   
    // Set the text of button1 to "OK".
    button1->Text = S"OK";
    // Set the position of the button on the form.
    button1->Location =  Point (10, 10);
    // Set the text of button2 to "Cancel".
    button2->Text = S"Cancel";
    // Set the position of the button based on the location of button1.
    button2->Location
       =  Point (button1->Left, button1->Height + button1->Top + 10);
    // Set the caption bar text of the form.   
    form1->Text = S"My Dialog Box";
    // Display a help button on the form.
    form1->HelpButton = true;
 
    // Define the border style of the form to a dialog box.
    form1->FormBorderStyle = FormBorderStyle::FixedDialog;
    // Set the MaximizeBox to false to remove the maximize box.
    form1->MaximizeBox = false;
    // Set the MinimizeBox to false to remove the minimize box.
    form1->MinimizeBox = false;
    // Set the accept button of the form to button1.
    form1->AcceptButton = button1;
    // Set the cancel button of the form to button2.
    form1->CancelButton = button2;
    // Set the start position of the form to the center of the screen.
    form1->StartPosition = FormStartPosition::CenterScreen;
    
    // Add button1 to the form.
    form1->Controls->Add(button1);
    // Add button2 to the form.
    form1->Controls->Add(button2);
    
    // Display the form as a modal dialog box.
    form1->ShowDialog();
 }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Form Class | Form Members | System.Windows.Forms Namespace | CancelButton | IButtonControl

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft