Form.HelpButton Form.HelpButton Form.HelpButton Form.HelpButton Property

Definición

Obtiene o establece un valor que indica si se muestra un botón de ayuda en el cuadro de título del formulario.Gets or sets a value indicating whether a Help button should be displayed in the caption box of the form.

public:
 property bool HelpButton { bool get(); void set(bool value); };
public bool HelpButton { get; set; }
member this.HelpButton : bool with get, set
Public Property HelpButton As Boolean

Valor de propiedad

true para mostrar un botón de ayuda en la barra de título del formulario; de lo contrario, false.true to display a Help button in the form's caption bar; otherwise, false. De manera predeterminada, es false.The default is false.

Ejemplos

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

Cuando esta propiedad se establece en true, aparece un botón pequeño con un signo de interrogación en la barra de título a la izquierda de la cerrar botón.When this property is set to true, a small button with a question mark appears in the caption bar to the left of the Close button. Puede usar este botón para mostrar la ayuda para la aplicación.You can use this button to display help for your application. Puede crear un controlador de eventos para el HelpRequested eventos para mostrar información de ayuda al usuario cuando se hace clic en el botón de Ayuda del formulario.You can create an event handler for the HelpRequested event to display Help information to the user when the Help button of the form is clicked.

Para mostrar un botón de ayuda, el valor de la forma ControlBox propiedad debe ser true, su valor predeterminado.To display a Help button, the value of the form's ControlBox property must be true, its default value. El ControlBox propiedad determina si la esquina superior derecha de la barra de título contiene controles como un botón Maximizar, un botón Minimizar, un botón de ayuda y un botón Cerrar.The ControlBox property determines whether the upper-right corner of the caption bar contains controls such as a maximize button, a minimize button, a help button, and a close button. Además, también debe establecer en el formulario FormBorderStyle propiedad FormBorderStyle.FixedSingle, FormBorderStyle.Sizable, FormBorderStyle.Fixed3D, o FormBorderStyle.FixedDialog.In addition, you must also set the form's FormBorderStyle property to FormBorderStyle.FixedSingle, FormBorderStyle.Sizable, FormBorderStyle.Fixed3D, or FormBorderStyle.FixedDialog.

Importante

El valor de la HelpButton propiedad se omite si el maximizar o minimizar se muestran los botones.The value of the HelpButton property is ignored if the Maximize or Minimize buttons are shown.

Se aplica a

Consulte también: