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

Definition

Ruft einen Wert ab, der angibt, ob auf der Titelleiste des Formulars die Hilfeschaltfläche angezeigt werden soll, oder legt diesen fest.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

Eigenschaftswert

true, um die Hilfeschaltfläche auf der Titelleiste des Formulars anzuzeigen, andernfalls false.true to display a Help button in the form's caption bar; otherwise, false. Die Standardeinstellung ist false.The default is false.

Beispiele

Im folgenden Beispiel wird eine neue Instanz von Form erstellt und die ShowDialog -Methode aufgerufen, um das Formular als Dialogfeld anzuzeigen.The following example creates a new instance of a Form and calls the ShowDialog method to display the form as a dialog box. Im Beispiel werden die FormBorderStyleEigenschaften AcceptButton, CancelButton, MinimizeBox, MaximizeBox, undStartPosition festgelegt, um die Darstellung und die Funktionalität des Formulars in ein Dialogfeld zu ändern.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. Im Beispiel wird auch die Add -Methode der- Controls Auflistung des Formulars verwendet, Button um zwei-Steuerelemente hinzuzufügen.The example also uses the Add method of the form's Controls collection to add two Button controls. Im Beispiel wird die HelpButton -Eigenschaft verwendet, um eine Hilfe Schaltfläche in der Titelleiste des Dialog Felds anzuzeigen.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

Hinweise

Wenn diese Eigenschaft auf truefestgelegt ist, wird in der Titelleiste links neben der Schaltfläche Schließen eine kleine Schaltfläche mit einem Fragezeichen angezeigt.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. Mit dieser Schaltfläche können Sie die Hilfe für die Anwendung anzeigen.You can use this button to display help for your application. Sie können einen Ereignishandler für das HelpRequested -Ereignis erstellen, um dem Benutzerhilfe Informationen anzuzeigen, wenn auf die Schaltfläche Hilfe des Formulars geklickt wird.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.

Um die Schaltfläche "Hilfe" anzuzeigen, muss der Wert ControlBox der-Eigenschaft truedes Formulars und dessen Standardwert lauten.To display a Help button, the value of the form's ControlBox property must be true, its default value. Die ControlBox -Eigenschaft bestimmt, ob die obere rechte Ecke der Titelleiste Steuerelemente wie z. b. eine Schaltfläche maximieren, eine Minimieren-Schaltfläche, eine Hilfe Schaltfläche und eine Schaltfläche Schließen enthält.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. Außerdem müssen Sie die- FormBorderStyle Eigenschaft des Formulars auf FormBorderStyle.FixedSingle, FormBorderStyle.Sizable, FormBorderStyle.Fixed3Doder FormBorderStyle.FixedDialogfestlegen.In addition, you must also set the form's FormBorderStyle property to FormBorderStyle.FixedSingle, FormBorderStyle.Sizable, FormBorderStyle.Fixed3D, or FormBorderStyle.FixedDialog.

Wichtig

Der Wert HelpButton der-Eigenschaft wird ignoriert, wenn die Schaltflächen maximieren oder minimieren angezeigt werden.The value of the HelpButton property is ignored if the Maximize or Minimize buttons are shown.

Gilt für:

Siehe auch