Help.ShowPopup(Control, String, Point) Method

Definition

Displays a Help pop-up window.

C#
public static void ShowPopup(System.Windows.Forms.Control parent, string caption, System.Drawing.Point location);
C#
public static void ShowPopup(System.Windows.Forms.Control? parent, string caption, System.Drawing.Point location);

Parameters

parent
Control

A Control that identifies the parent of the Help dialog box.

caption
String

The message to display in the pop-up window.

location
Point

A value that specifies the horizontal and vertical coordinates at which to display the pop-up window, relative to the upper-left corner of the screen.

Examples

The following code example uses the KeyUp event with the Help class to display pop-up style help to the user.

C#
// This example demonstrates how to use the KeyUp event with the Help class to display
// pop-up style help to the user of the application. When the user presses F1, the Help
// class displays a pop-up window, similar to a ToolTip, near the control. This example assumes
// that a TextBox control, named textBox1, has been added to the form and its KeyUp
// event has been contected to this event handler method.
private void textBox1_KeyUp(object sender, System.Windows.Forms.KeyEventArgs e)
{
    // Determine whether the key entered is the F1 key. Display help if it is.
    if(e.KeyCode == Keys.F1)
    {
        // Display a pop-up help topic to assist the user.
        Help.ShowPopup(textBox1, "Enter your first name", new Point(textBox1.Right, this.textBox1.Bottom));
    }
}

Applies to

Product Versions
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9, 10

See also