Help.ShowPopup Method (Control, String, Point)

 
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.

Displays a Help pop-up window.

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

public static void ShowPopup(
	Control parent,
	string caption,
	Point location
)

Parameters

parent
Type: System.Windows.Forms.Control

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

caption
Type: System.String

The message to display in the pop-up window.

location
Type: System.Drawing.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.

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

// 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));
    }
}

.NET Framework
Available since 1.1
Return to top
Show: