Form.CancelButton Propiedad

Definición

Obtiene o establece el control de botón que se activará cuando el usuario presione la tecla 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

Valor de propiedad

IButtonControl que representa el botón Cancelar del formulario.An IButtonControl that represents the cancel button for the form.

Ejemplos

En el ejemplo siguiente se crea una nueva instancia de un Form y se llama al método ShowDialog para mostrar el formulario como un cuadro de diálogo.The following example creates a new instance of a Form and calls the ShowDialog method to display the form as a dialog box. En el ejemplo se establecen las propiedades FormBorderStyle, AcceptButton, CancelButton, MinimizeBox, MaximizeBoxy StartPosition para cambiar la apariencia y la funcionalidad del formulario a un cuadro de diálogo.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. En el ejemplo también se usa el método Add de la colección Controls del formulario para agregar dos controles Button.The example also uses the Add method of the form's Controls collection to add two Button controls. En el ejemplo se usa la propiedad HelpButton para mostrar un botón ayuda en la barra de título del cuadro de diálogo.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

Comentarios

El botón Cancelar de un formulario es el control de botón en el que se hace clic cuando el usuario presiona la tecla ESC.The cancel button for a form is the button control that is clicked whenever the user presses the ESC key. El botón asignado a esta propiedad debe ser un IButtonControl que esté en el formulario actual o que se encuentre dentro de un contenedor del formulario actual.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.

Esta propiedad permite designar una acción predeterminada para que se produzca cuando el usuario presione la tecla ESC en la aplicación.This property allows you to designate a default action to occur when the user presses the ESC key in your application. Puede usar esta propiedad para permitir que el usuario navegue rápidamente por un formulario sencillo permitiéndoles presionar simplemente la tecla ESC para cerrar una ventana sin confirmar los cambios en lugar de hacer clic manualmente en el botón Cancelar con el mouse.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.

CancelButton puede que no funcione si otro control del formulario intercepta la tecla ESC.CancelButton may not work if another control on the form intercepts the ESC key. Por ejemplo, si tiene un ComboBox abierto en el formulario, ESC cerrará el ComboBox en lugar de cerrar el formulario.For example, if you have a ComboBox open on your form, ESC will close the ComboBox instead of closing the Form.

El IButtonControl objeto asignado a CancelButton debe estar visible en el formulario o, de lo contrario, presionar la tecla ESC no tendrá ningún efecto.The IButtonControl object assigned to CancelButton must be visible on the form, or else pressing the ESC key will have no effect.

Se aplica a

Consulte también: