Form.HelpButton Свойство

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Возвращает или задает значение, указывающее, отображать ли кнопку "Справка" в заголовке формы.

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

Значение свойства

Boolean

Значение true для отображения кнопки "Справка" в заголовке формы; в противном случае — значение false. Значение по умолчанию — false.

Примеры

В следующем примере создается новый экземпляр Form и вызывается ShowDialog метод для отображения формы в виде диалогового окна. В примере задаются FormBorderStyleсвойства , AcceptButton, CancelButton, MinimizeBox, MaximizeBoxи StartPosition , чтобы изменить внешний вид и функциональность формы на диалоговое окно. В примере также используется Add метод коллекции формы Controls для добавления двух Button элементов управления. В примере свойство используется для HelpButton отображения кнопки Справка на панели подпись диалогового окна.

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

Комментарии

Если для этого свойства задано значение true, на панели подпись слева от кнопки Закрыть отображается небольшая кнопка с вопросительным знаком. Эту кнопку можно использовать для отображения справки по приложению. Вы можете создать обработчик событий для HelpRequested события, чтобы при нажатии кнопки Справка формы отображалась справочная информация.

Чтобы отобразить кнопку "Справка", свойство формы ControlBox должно иметь trueзначение по умолчанию. Свойство ControlBox определяет, содержит ли правый верхний угол панели подпись такие элементы управления, как кнопка развертывания, кнопка свернуть, кнопка справки и кнопка закрытия. Кроме того, необходимо также задать для свойства формы FormBorderStyle значение FormBorderStyle.FixedSingle, FormBorderStyle.Sizable, FormBorderStyle.Fixed3Dили FormBorderStyle.FixedDialog.

Важно!

Значение HelpButton свойства игнорируется, если отображаются кнопки Развернуть или Свернуть .

См. также раздел

• MinimizeBox
• MaximizeBox
• ControlBox
• HelpButtonClicked