Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 3.21 KB

how-to-display-pop-up-help.md

File metadata and controls

42 lines (30 loc) · 3.21 KB
Raw
title ms.date helpviewer_keywords ms.assetid description
How to: Display Pop-up Help
03/30/2017
pop-up Help
Help [Windows Forms], pop-up Help
Windows Forms, displaying Help
forms [Windows Forms], displaying Help
modal dialog boxes [Windows Forms], pop-up Help
F1 Help [Windows Forms], in dialog boxes
HelpProvider component [Windows Forms]
Help [Windows Forms], adding to dialog boxes
218aa81e-e87e-4d67-af05-11627bbdce3b
Learn how to display the pop-up Help on Windows Forms through the Help button, accessible through the HelpButton property.

How to: Display pop-up Help

One way to display Help on Windows Forms is through the Help button, located on the right side of the title bar, accessible through the xref:System.Windows.Forms.Form.HelpButton%2A property. This type of Help display is well-suited for use with dialog boxes. Dialog boxes shown modally (with the xref:System.Windows.Forms.Form.ShowDialog%2A method) have trouble bringing up external Help systems, because modal dialog boxes need to be closed before focus can shift to another window. Additionally, using the Help button requires that there is no Minimize button or Maximize button shown in the title bar. This is a standard dialog-box convention, whereas forms usually have Minimize and Maximize buttons.

You can also use the xref:System.Windows.Forms.HelpProvider component to link controls to files in a Help system, even if you have implemented pop-up Help. For more information, see Providing Help in a Windows Application.

Display pop-up Help

  1. In Visual Studio, drag a HelpProvider component from the Toolbox to your form.

    It will sit in the tray at the bottom of the Windows Forms Designer.

  2. In the Properties window, set the xref:System.Windows.Forms.Form.HelpButton%2A property to true. This will display a button with a question mark in it on the right side of the title bar of the form.

  3. In order for the xref:System.Windows.Forms.Form.HelpButton%2A to display, the form's xref:System.Windows.Forms.Form.MinimizeBox%2A and xref:System.Windows.Forms.Form.MaximizeBox%2A properties must be set to false, the xref:System.Windows.Forms.Form.ControlBox%2A property set to true, and the xref:System.Windows.Forms.Form.FormBorderStyle%2A property to one of the following values: xref:System.Windows.Forms.FormBorderStyle.FixedSingle, xref:System.Windows.Forms.FormBorderStyle.Fixed3D, xref:System.Windows.Forms.FormBorderStyle.FixedDialog or xref:System.Windows.Forms.FormBorderStyle.Sizable.

  4. Select the control for which you want to show help on your form and set the Help string in the Properties window. This is the string of text that will be displayed in a window similar to a ToolTip.

  5. Press F5.

  6. Press the Help button on the title bar and click the control on which you set the Help string.

See also