Form.HelpButton Свойство

Определение

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

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Исходный код:

Form.cs

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

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и MinimizeBoxCancelButtonMaximizeBoxсвойства для изменения внешнего вида и 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.Sizableили FormBorderStyle.Fixed3DFormBorderStyle.FixedDialog.FormBorderStyle.FixedSingle

Это важно

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

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

• MinimizeBox
• MaximizeBox
• ControlBox
• HelpButtonClicked