Form.AcceptButton Property (System.Windows.Forms)

AcceptButton Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

Form..::.AcceptButton Property

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

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic

Public Property AcceptButton As IButtonControl

public IButtonControl AcceptButton { get; set; }

Visual C++

public:
property IButtonControl^ AcceptButton {
    IButtonControl^ get ();
    void set (IButtonControl^ value);
}

member AcceptButton : IButtonControl with get, set

Property Value

Type: System.Windows.Forms..::.IButtonControl
An IButtonControl that represents the button to use as the accept button for the form.

Remarks

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.

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.

Examples

The following code 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

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

Visual C++

public:
   void CreateMyForm()
   {
      // Create a new instance of the form.
      Form^ form1 = gcnew Form;
      // Create two buttons to use as the accept and cancel buttons.
      Button^ button1 = gcnew Button;
      Button^ button2 = gcnew Button;

      // Set the text of button1 to "OK".
      button1->Text = "OK";
      // Set the position of the button on the form.
      button1->Location = 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 =
         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();
   }

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Form Class

System.Windows.Forms Namespace

CancelButton

IButtonControl

Tags

: Add a tag

Community Content

Add new content

Annotations

JScript .Net Example

Max Hanselot | Edit | Show History

import System.Windows.Forms; // this has the windows forms objects
import System.Drawing;
import Accessibility;
public class CreateMyForm extends System.Windows.Forms.Form
{
var that = this;
//type the form controls
var button1 : System.Windows.Forms.Button;
var button2 : System.Windows.Forms.Button;

//Class main script
function CreateMyForm() {
InitializeComponent();
}

function InitializeComponent(){
// Create two buttons to use as the accept and cancel buttons.
that.button1 =new System.Windows.Forms.Button();
that.button2 =new System.Windows.Forms.Button();

//Set the accept and cancel buttons properties
// Set the text of button1 to "OK".
that.button1.Text = "OK";
// Set the position of the button on the form.
that.button1.Location = new Point (10, 10);
// Set the text of button2 to "Cancel".
that.button2.Text = "Cancel";
// Set the position of the button based on the location of button1.
that.button2.Location
= new Point (button1.Left, that.button1.Height + that.button1.Top + 10);

//Add the controsl to CreateMyForm form
// Add button1 to the form.
that.Controls.Add(button1);
// Add button2 to the form.
that.Controls.Add(button2);

//Set CreateMyForm form properties

// Set the caption bar text of the form.
that.Text = "My Dialog Box";
// Display a help button on the form.
that.HelpButton = true;
// Define the border style of the form to a dialog box.
that.FormBorderStyle = System.Windows.Forms.FormBorderStyle.FixedDialog;
// Set the MaximizeBox to false to remove the maximize box.
that.MaximizeBox = false;
// Set the MinimizeBox to false to remove the minimize box.
that.MinimizeBox = false;
// Set the accept button of the form to button1.
that.AcceptButton = that.button1;
// Set the cancel button of the form to button2.
that.CancelButton = that.button2;
// Set the start position of the form to the center of the screen.
that.StartPosition = System.Windows.Forms.FormStartPosition.CenterScreen;
}
}

// Create a new instance of the form.
var form1 : CreateMyForm = new CreateMyForm();

// Display the form as a modal dialog box.
form1.ShowDialog();