Form.AcceptButton プロパティ

ユーザーが Enter キーを押したときにクリックされる、フォーム上のボタンを取得または設定します。

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

プロパティ値

フォームの確定ボタンとして使用するボタンを表す IButtonControl

解説

このプロパティを使用すると、アプリケーションでユーザーが Enter キーを押したときに発生する既定のアクションを指定できます。このプロパティに割り当てるボタンは、 IButtonControl を実装し、現在のフォーム上、または現在のフォーム上のコンテナ内にあることが必要です。

このプロパティを使用すると、ユーザーがフォーム上で操作を終了したときに、マウスで確定ボタンをクリックするのではなく、Enter キーを押すだけで済むようになります。

フォーム上で現在選択されているコントロールが Enter キーに反応して処理を行っても、確定ボタンがアクティブにならない場合があります。たとえば、複数行のテキスト ボックス コントロールでは、コントロール内に改行文字を挿入するために Enter キーを押すことができるようにします。

使用例

[Visual Basic, C#, C++] Form の新しいインスタンスを作成し、 ShowDialog メソッドを呼び出して、フォームをダイアログ ボックスとして表示する例を次に示します。この例では、 FormBorderStyleAcceptButtonCancelButtonMinimizeBoxMaximizeBoxStartPosition の各プロパティを設定してフォームの外観と機能を変更し、ダイアログ ボックスとして表示します。この例では、フォームの Controls コレクションの Add メソッドを使用して、2 つの Button コントロールも追加します。また、 HelpButton プロパティを使用して、ダイアログ ボックスのキャプション バーにヘルプ ボタンを表示します。

 
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] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン 言語のフィルタ をクリックします。

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

参照

Form クラス | Form メンバ | System.Windows.Forms 名前空間 | CancelButton | IButtonControl