This documentation is archived and is not being maintained.

NotifyIcon.Text Property

Gets or sets the ToolTip text displayed when the mouse pointer rests on a notification area icon.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

[LocalizableAttribute(true)] 
public string Text { get; set; }
/** @property */
public String get_Text ()

/** @property */
public void set_Text (String value)

public function get Text () : String

public function set Text (value : String)

Property Value

The ToolTip text displayed when the mouse pointer rests on a notification area icon.

Exception typeCondition

ArgumentException

ToolTip text is more than 64 characters long.

If the text is a null reference (Nothing in Visual Basic), no ToolTip is displayed.

The following code example demonstrates using the NotifyIcon class to display an icon for an application in the notification area. The example demonstrates setting the Icon, ContextMenu, Text, and Visible properties and handling the DoubleClick event. A ContextMenu with an Exit item on it is assigned to the NotifyIcon.ContextMenu property, which allows the user to close the application. When the DoubleClick event occurs, the application form is activated by calling the Form.Activate method.

using System;
using System.Drawing;
using System.Windows.Forms;

public class Form1 : System.Windows.Forms.Form
{
    private System.Windows.Forms.NotifyIcon notifyIcon1;
    private System.Windows.Forms.ContextMenu contextMenu1;
    private System.Windows.Forms.MenuItem menuItem1;
    private System.ComponentModel.IContainer components;

    [STAThread]
    static void Main() 
    {
        Application.Run(new Form1());
    }

    public Form1()
    {
        this.components = new System.ComponentModel.Container();
        this.contextMenu1 = new System.Windows.Forms.ContextMenu();
        this.menuItem1 = new System.Windows.Forms.MenuItem();

        // Initialize contextMenu1
        this.contextMenu1.MenuItems.AddRange(
                    new System.Windows.Forms.MenuItem[] {this.menuItem1});

        // Initialize menuItem1
        this.menuItem1.Index = 0;
        this.menuItem1.Text = "E&xit";
        this.menuItem1.Click += new System.EventHandler(this.menuItem1_Click);

        // Set up how the form should be displayed.
        this.ClientSize = new System.Drawing.Size(292, 266);
        this.Text = "Notify Icon Example";

        // Create the NotifyIcon.
        this.notifyIcon1 = new System.Windows.Forms.NotifyIcon(this.components);

        // The Icon property sets the icon that will appear
        // in the systray for this application.
        notifyIcon1.Icon = new Icon("appicon.ico");

        // The ContextMenu property sets the menu that will
        // appear when the systray icon is right clicked.
        notifyIcon1.ContextMenu = this.contextMenu1;

        // The Text property sets the text that will be displayed,
        // in a tooltip, when the mouse hovers over the systray icon.
        notifyIcon1.Text = "Form1 (NotifyIcon example)";
        notifyIcon1.Visible = true;

        // Handle the DoubleClick event to activate the form.
        notifyIcon1.DoubleClick += new System.EventHandler(this.notifyIcon1_DoubleClick);

    }

    protected override void Dispose( bool disposing )
    {
        // Clean up any components being used.
        if( disposing )
            if (components != null)
                components.Dispose();            

        base.Dispose( disposing );
    }

    private void notifyIcon1_DoubleClick(object Sender, EventArgs e) 
    {
        // Show the form when the user double clicks on the notify icon.

        // Set the WindowState to normal if the form is minimized.
        if (this.WindowState == FormWindowState.Minimized)
            this.WindowState = FormWindowState.Normal;

        // Activate the form.
        this.Activate();
    }

    private void menuItem1_Click(object Sender, EventArgs e) {
        // Close the form, which closes the application.
        this.Close();
    }
}

import System.*;
import System.Drawing.*;
import System.Windows.Forms.*;

public class Form1 extends System.Windows.Forms.Form
{
    private System.Windows.Forms.NotifyIcon notifyIcon1;
    private System.Windows.Forms.ContextMenu contextMenu1;
    private System.Windows.Forms.MenuItem menuItem1;
    private System.ComponentModel.IContainer components;

    /** @attribute STAThread()
     */
    public static void main(String[] args)
    {
        Application.Run(new Form1());
    } //main

    public Form1()
    {
        this.components = new System.ComponentModel.Container();
        this.contextMenu1 = new System.Windows.Forms.ContextMenu();
        this.menuItem1 = new System.Windows.Forms.MenuItem();
        // Initialize contextMenu1
        this.contextMenu1.get_MenuItems().AddRange(
            new System.Windows.Forms.MenuItem[] { this.menuItem1 });
        // Initialize menuItem1
        this.menuItem1.set_Index(0);
        this.menuItem1.set_Text("E&xit");
        this.menuItem1.add_Click(new System.EventHandler(this.menuItem1_Click));
        // Set up how the form should be displayed.
        this.set_ClientSize(new System.Drawing.Size(292, 266));
        this.set_Text("Notify Icon Example");
        // Create the NotifyIcon.
        this.notifyIcon1 = new System.Windows.Forms.NotifyIcon(this.components);
        // The Icon property sets the icon that will appear
        // in the systray for this application.
        notifyIcon1.set_Icon(new Icon("appicon.ico"));
        // The ContextMenu property sets the menu that will
        // appear when the systray icon is right clicked.
        notifyIcon1.set_ContextMenu(this.contextMenu1);
        // The Text property sets the text that will be displayed,
        // in a tooltip, when the mouse hovers over the systray icon.
        notifyIcon1.set_Text("Form1 (NotifyIcon example)");
        notifyIcon1.set_Visible(true);
        // Handle the DoubleClick event to activate the form.
        notifyIcon1.add_DoubleClick(
            new System.EventHandler(this.notifyIcon1_DoubleClick));
    } //Form1

    protected void Dispose(boolean disposing)
    {
        // Clean up any components being used.
        if (disposing) {
            if (components != null) {
                components.Dispose();
            }
        }

        super.Dispose(disposing);
    } //Dispose

    private void notifyIcon1_DoubleClick(Object Sender, EventArgs e)
    {
        // Show the form when the user double clicks on the notify icon.
        // Set the WindowState to normal if the form is minimized.
        if (this.get_WindowState().Equals(FormWindowState.Minimized)) {
            this.set_WindowState(FormWindowState.Normal);
        }
        // Activate the form.
        this.Activate();
    } //notifyIcon1_DoubleClick

    private void menuItem1_Click(Object Sender, EventArgs e)
    {
        // Close the form, which closes the application.
        this.Close();
    } //menuItem1_Click
} //Form1

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0
Show: