Form.HelpButton Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value indicating whether a Help button should be displayed in the caption box of the form.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

member HelpButton : bool with get, set

Property Value

Type: System.Boolean

true to display a Help button in the form's caption bar; otherwise, false. The default is false.

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. You can create an event handler for the HelpRequested event of the Control class to display Help information to the user when the Help button of the form is clicked.

System_CAPS_importantImportant

The value of the HelpButton property is ignored if the Maximize or Minimize buttons are shown.

The following code example creates a new instance of a Form and calls the ShowDialog method to display the form as a dialog box. 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. The example also uses the Add method of the form's Controls collection to add two Button controls. The example uses the HelpButton property to display a Help button in the caption bar of the dialog box.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show: