Form.HelpButton 属性

定义

获取或设置一个值,该值指示是否应在窗体的标题框中显示“帮助”按钮。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

属性值

如果为 true,则在窗体的标题栏中显示“帮助”按钮;否则,为 falsetrue to display a Help button in the form's caption bar; otherwise, false. 默认值为 falseThe default is false.

示例

下面的示例创建 Form 的新实例,并调用 ShowDialog 方法将窗体显示为对话框。The following example creates a new instance of a Form and calls the ShowDialog method to display the form as a dialog box. 该示例设置了 "FormBorderStyle"、"AcceptButton"、"CancelButton"、"MinimizeBox"、"MaximizeBox" 和 "StartPosition" 属性,将窗体的外观和功能更改为对话框。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. 该示例还使用窗体的 Controls 集合的 Add 方法来添加两个 Button 控件。The example also uses the Add method of the form's Controls collection to add two Button controls. 该示例使用 HelpButton 属性在对话框的标题栏中显示 "帮助" 按钮。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

注解

当此属性设置为 true 时,"关闭" 按钮左侧的标题栏中将显示一个带问号的小按钮。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. 此按钮可用于显示应用程序的帮助。You can use this button to display help for your application. 可以为 HelpRequested 事件创建事件处理程序,以便在单击窗体的 "帮助" 按钮时向用户显示帮助信息。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.

若要显示 "帮助" 按钮,必须 true窗体的 ControlBox 属性的值,其默认值为。To display a Help button, the value of the form's ControlBox property must be true, its default value. ControlBox 属性确定标题栏的右上角是否包含控件,如 "最大化" 按钮、"最小化" 按钮、"帮助" 按钮和 "关闭" 按钮。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. 此外,还必须将窗体的 FormBorderStyle 属性设置为 FormBorderStyle.FixedSingleFormBorderStyle.SizableFormBorderStyle.Fixed3DFormBorderStyle.FixedDialogIn addition, you must also set the form's FormBorderStyle property to FormBorderStyle.FixedSingle, FormBorderStyle.Sizable, FormBorderStyle.Fixed3D, or FormBorderStyle.FixedDialog.

重要

如果显示最大化最小化按钮,则忽略 HelpButton 属性的值。The value of the HelpButton property is ignored if the Maximize or Minimize buttons are shown.

适用于

另请参阅