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 呼び出してフォームをダイアログ ボックスとして表示します。 この例では、FormBorderStyleMinimizeBoxMaximizeBoxAcceptButtonCancelButtonおよび StartPosition プロパティを設定して、フォームの外観と機能をダイアログ ボックスに変更します。 この例では、フォームControlsのコレクションの メソッドを使用Addして、2 つの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.SizableFormBorderStyle.Fixed3Dまたは FormBorderStyle.FixedDialogに設定するFormBorderStyle.FixedSingle必要もあります。

重要

[最大化] HelpButton または [最小化] ボタンが表示されている場合、プロパティの値は無視されます。

こちらもご覧ください

• MinimizeBox
• MaximizeBox
• ControlBox
• HelpButtonClicked