Teilen über


Form.HelpButton Eigenschaft

Definition

Ruft einen Wert ab, der angibt, ob auf der Titelleiste des Formulars die Hilfeschaltfläche angezeigt werden soll, oder legt diesen fest.

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. Der Standardwert ist false.

Beispiele

Im folgenden Beispiel wird eine neue instance eines Form erstellt und die ShowDialog -Methode aufgerufen, um das Formular als Dialogfeld anzuzeigen. Im Beispiel werden die FormBorderStyleEigenschaften , AcceptButton, CancelButton, MinimizeBox, MaximizeBoxund StartPosition festgelegt, um die Darstellung und Funktionalität des Formulars in ein Dialogfeld zu ändern. Im Beispiel wird auch die Add -Methode der Formularauflistung Controls verwendet, um zwei Button Steuerelemente hinzuzufügen. Im Beispiel wird die HelpButton -Eigenschaft verwendet, um eine Hilfeschaltfläche in der Untertitel leiste des Dialogfelds anzuzeigen.

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 links neben der Schaltfläche Schließen eine kleine Schaltfläche mit einem Fragezeichen in der Untertitel leiste angezeigt. Sie können diese Schaltfläche verwenden, um Hilfe für Ihre Anwendung anzuzeigen. Sie können einen Ereignishandler für das HelpRequested Ereignis erstellen, um dem Benutzer Hilfeinformationen anzuzeigen, wenn auf die Schaltfläche Hilfe des Formulars geklickt wird.

Um eine Hilfeschaltfläche anzuzeigen, muss der Wert der Eigenschaft des Formulars ControlBox als Standardwert festgelegt sein true. Die ControlBox -Eigenschaft bestimmt, ob die obere rechte Ecke der Untertitel leiste Steuerelemente enthält, z. B. eine Schaltfläche "Maximieren", eine Schaltfläche "Minimieren", eine Hilfeschaltfläche und eine Schaltfläche "Schließen". Darüber hinaus müssen Sie die Eigenschaft des Formulars FormBorderStyle auch auf FormBorderStyle.FixedSingle, FormBorderStyle.Sizable, FormBorderStyle.Fixed3Doder FormBorderStyle.FixedDialogfestlegen.

Wichtig

Der Wert der HelpButton -Eigenschaft wird ignoriert, wenn die Schaltflächen Maximieren oder Minimieren angezeigt werden.

Gilt für:

Weitere Informationen