NotifyIcon Class

 

Specifies a component that creates an icon in the notification area. This class cannot be inherited.

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

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.NotifyIcon

Public NotInheritable Class NotifyIcon
	Inherits Component

NameDescription
System_CAPS_pubmethodNotifyIcon()

Initializes a new instance of the NotifyIcon class.

System_CAPS_pubmethodNotifyIcon(IContainer)

Initializes a new instance of the NotifyIcon class with the specified container.

NameDescription
System_CAPS_pubpropertyBalloonTipIcon

Gets or sets the icon to display on the balloon tip associated with the NotifyIcon.

System_CAPS_pubpropertyBalloonTipText

Gets or sets the text to display on the balloon tip associated with the NotifyIcon.

System_CAPS_pubpropertyBalloonTipTitle

Gets or sets the title of the balloon tip displayed on the NotifyIcon.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyContextMenu

Gets or sets the shortcut menu for the icon.

System_CAPS_pubpropertyContextMenuStrip

Gets or sets the shortcut menu associated with the NotifyIcon.

System_CAPS_pubpropertyIcon

Gets or sets the current icon.

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertyTag

Gets or sets an object that contains data about the NotifyIcon.

System_CAPS_pubpropertyText

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

System_CAPS_pubpropertyVisible

Gets or sets a value indicating whether the icon is visible in the notification area of the taskbar.

NameDescription
System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodShowBalloonTip(Int32)

Displays a balloon tip in the taskbar for the specified time period.

System_CAPS_pubmethodShowBalloonTip(Int32, String, String, ToolTipIcon)

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

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

NameDescription
System_CAPS_pubeventBalloonTipClicked

Occurs when the balloon tip is clicked.

System_CAPS_pubeventBalloonTipClosed

Occurs when the balloon tip is closed by the user.

System_CAPS_pubeventBalloonTipShown

Occurs when the balloon tip is displayed on the screen.

System_CAPS_pubeventClick

Occurs when the user clicks the icon in the notification area.

System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

System_CAPS_pubeventDoubleClick

Occurs when the user double-clicks the icon in the notification area of the taskbar.

System_CAPS_pubeventMouseClick

Occurs when the user clicks a NotifyIcon with the mouse.

System_CAPS_pubeventMouseDoubleClick

Occurs when the user double-clicks the NotifyIcon with the mouse.

System_CAPS_pubeventMouseDown

Occurs when the user presses the mouse button while the pointer is over the icon in the notification area of the taskbar.

System_CAPS_pubeventMouseMove

Occurs when the user moves the mouse while the pointer is over the icon in the notification area of the taskbar.

System_CAPS_pubeventMouseUp

Occurs when the user releases the mouse button while the pointer is over the icon in the notification area of the taskbar.

Icons in the notification area are shortcuts to processes that are running in the background of a computer, such as a virus protection program or a volume control. These processes do not come with their own user interfaces. The NotifyIcon class provides a way to program in this functionality. The Icon property defines the icon that appears in the notification area. Pop-up menus for an icon are addressed with the ContextMenu property. The Text property assigns ToolTip text. In order for the icon to show up in the notification area, the Visible property must be set to true.

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.

Imports System
Imports System.Drawing
Imports System.Windows.Forms

Public NotInheritable Class Form1
    Inherits System.Windows.Forms.Form

    Private contextMenu1 As System.Windows.Forms.ContextMenu
    Friend WithEvents menuItem1 As System.Windows.Forms.MenuItem
    Friend WithEvents notifyIcon1 As System.Windows.Forms.NotifyIcon
    Private components As System.ComponentModel.IContainer

    <System.STAThread()> _
    Public Shared Sub Main()
        System.Windows.Forms.Application.Run(New Form1)
    End Sub 'Main

    Public Sub New()

        Me.components = New System.ComponentModel.Container
        Me.contextMenu1 = New System.Windows.Forms.ContextMenu
        Me.menuItem1 = New System.Windows.Forms.MenuItem

        ' Initialize contextMenu1
        Me.contextMenu1.MenuItems.AddRange(New System.Windows.Forms.MenuItem() _
                            {Me.menuItem1})

        ' Initialize menuItem1
        Me.menuItem1.Index = 0
        Me.menuItem1.Text = "E&xit"

        ' Set up how the form should be displayed.
        Me.ClientSize = New System.Drawing.Size(292, 266)
        Me.Text = "Notify Icon Example"

        ' Create the NotifyIcon.
        Me.notifyIcon1 = New System.Windows.Forms.NotifyIcon(Me.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 = Me.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
    End Sub 'NewNew

    Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
        ' Clean up any components being used.
        If disposing Then
            If (components IsNot Nothing) Then
                components.Dispose()
            End If
        End If
        MyBase.Dispose(disposing)
    End Sub 'Dispose

    Private Sub notifyIcon1_DoubleClick(Sender as object, e as EventArgs) handles notifyIcon1.DoubleClick
        ' Show the form when the user double clicks on the notify icon.

        ' Set the WindowState to normal if the form is minimized.
        if (me.WindowState = FormWindowState.Minimized) then _
            me.WindowState = FormWindowState.Normal

        ' Activate the form.
        me.Activate()
    end sub

    Private Sub menuItem1_Click(Sender as object, e as EventArgs) handles menuItem1.Click
        ' Close the form, which closes the application.
        me.Close()
    end sub

End Class 'Form1

UIPermission

to create the NotifyIcon component. Associated enumeration: UIPermissionWindow.AllWindows

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: