Form.CancelButton Form.CancelButton Form.CancelButton Form.CancelButton Property

定義

ユーザーが Esc キーを押したときにクリックされるボタン コントロールを取得または設定します。Gets or sets the button control that is clicked when the user presses the ESC key.

public:
 property System::Windows::Forms::IButtonControl ^ CancelButton { System::Windows::Forms::IButtonControl ^ get(); void set(System::Windows::Forms::IButtonControl ^ value); };
public System.Windows.Forms.IButtonControl CancelButton { get; set; }
member this.CancelButton : System.Windows.Forms.IButtonControl with get, set
Public Property CancelButton As IButtonControl

プロパティ値

フォームの [キャンセル] ボタンを表す IButtonControlAn IButtonControl that represents the cancel button for the form.

次の例では、Form の新しいインスタンスを作成し、ShowDialog メソッドを呼び出してフォームをダイアログボックスとして表示します。The following example creates a new instance of a Form and calls the ShowDialog method to display the form as a dialog box. この例では、FormBorderStyleAcceptButtonCancelButtonMinimizeBoxMaximizeBox、および StartPosition の各プロパティを設定して、フォームの外観と機能をダイアログボックスに変更します。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. また、この例では、フォームの @no__t コレクションの Add メソッドを使用して、2つの @no__t 2 つのコントロールを追加しています。The example also uses the Add method of the form's Controls collection to add two Button controls. この例では、HelpButton プロパティを使用して、ダイアログボックスのキャプションバーに [ヘルプ] ボタンを表示します。The example uses the HelpButton property to display a help button in the caption bar of the dialog box.

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

注釈

フォームの [キャンセル] ボタンは、ユーザーが ESC キーを押したときにクリックされるボタンコントロールです。The cancel button for a form is the button control that is clicked whenever the user presses the ESC key. このプロパティに割り当てられたボタンは、現在のフォームにあるか、現在のフォームのコンテナー内にある @no__t 0 である必要があります。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.

このプロパティを使用すると、ユーザーがアプリケーションで ESC キーを押したときに実行される既定のアクションを指定できます。This property allows you to designate a default action to occur when the user presses the ESC key in your application. このプロパティを使用すると、ユーザーが簡単なフォームをすばやく移動できるようにすることができます。そのためには、マウスで [キャンセル] ボタンを手動でクリックする代わりに、ESC キーを押すだけで、変更をコミットせずにウィンドウを閉じることができます。You can use this property to allow the user to quickly navigate a simple form by allowing them to simply press the ESC key to close a window without committing changes instead of manually clicking the cancel button with their mouse.

フォーム上の別のコントロールが ESC キーをインターセプトした場合、CancelButton が機能しない可能性があります。CancelButton may not work if another control on the form intercepts the ESC key. たとえば、フォームに @no__t 0 が開いている場合、ESC はフォームを閉じるのではなく、ComboBox を閉じます。For example, if you have a ComboBox open on your form, ESC will close the ComboBox instead of closing the Form.

@No__t-1 に割り当てられた @no__t 0 オブジェクトはフォームに表示されている必要があります。そうしないと、ESC キーを押しても効果はありません。The IButtonControl object assigned to CancelButton must be visible on the form, or else pressing the ESC key will have no effect.

適用対象

こちらもご覧ください