Export (0) Print
Expand All

NotifyIcon.ShowBalloonTip Method (Int32, String, String, ToolTipIcon)

Displays a balloon tip with the specified title, text, and icon in the taskbar for the specified time period.

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

public void ShowBalloonTip(
	int timeout,
	string tipTitle,
	string tipText,
	ToolTipIcon tipIcon
)

Parameters

timeout
Type: System.Int32

The time period, in milliseconds, the balloon tip should display.

tipTitle
Type: System.String

The title to display on the balloon tip.

tipText
Type: System.String

The text to display on the balloon tip.

tipIcon
Type: System.Windows.Forms.ToolTipIcon

One of the ToolTipIcon values.

ExceptionCondition
ArgumentOutOfRangeException

timeout is less than 0.

ArgumentException

tipText is null or an empty string.

InvalidEnumArgumentException

tipIcon is not a member of ToolTipIcon.

Minimum and maximum timeout values are enforced by the operating system and are typically 10 and 30 seconds, respectively, however this can vary depending on the operating system. Timeout values that are too large or too small are adjusted to the appropriate minimum or maximum value. In addition, if the user does not appear to be using the computer (no keyboard or mouse events are occurring) then the system does not count this time towards the timeout.

Only one balloon tip can display on the taskbar at a time. Attempting to display a balloon tip when one is currently displayed on the taskbar causes the timeout value to be ignored. The behavior is slightly different depending on the operating system and whether the balloon tip is from another, or the same, application. When the second balloon tip is from another application, the first balloon tip will display for the minimum timeout value before the second appears, regardless of the value of timeout. In most cases, if the balloon tips are from the same application, the first balloon tip immediately closes when another call to the ShowBalloonTip method is made. In some cases the second balloon will open on top of the first balloon.

The title text will display in a bold font near the top of the balloon.

The following code example demonstrates how to use the ShowBalloonTip method. To run this example, paste the example code into a Windows Form that contains a NotifyIcon named notifyIcon1. Associate the Form1_DoubleClick method in this example with the form's DoubleClick event.

void Form1_DoubleClick(object sender, EventArgs e)
{
    notifyIcon1.Visible = true;
    notifyIcon1.ShowBalloonTip(20000, "Information", "This is the text",
        ToolTipIcon.Info );
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft