Class
RadNotifyIcon

Represents a control that can be used to display an icon in the Windows' taskbar notification area. The icon can then respond to user interaction as well as display tooltips, popups, balloon notifications and context menu.

Definition

Constructors

RadNotifyIcon()

Initializes a new instance of the RadNotifyIcon class.

Declaration

cs-api-definition
public RadNotifyIcon()

Properties

BalloonIcon

Gets or sets the icon of the balloon tip to be show when the ShowBalloonTip(int) method is called.

Declaration

cs-api-definition
[Browsable(true)]
public Icon BalloonIcon { get; set; }

Property Value

Icon

BalloonText

Gets or sets the text of the balloon tip to be show when the ShowBalloonTip(int) method is called.

Declaration

cs-api-definition
[Browsable(true)]
public string BalloonText { get; set; }

Property Value

string

BalloonTitle

Gets or sets the title of the balloon tip to be show when the ShowBalloonTip(int) method is called.

Declaration

cs-api-definition
[Browsable(true)]
public string BalloonTitle { get; set; }

Property Value

string

ContextMenuActivationMouseEvent

Gets or sets the mouse action that must be performed over the notify icon to show the TrayContextMenu.

Declaration

cs-api-definition
[Browsable(true)]
public MouseActivationEvent ContextMenuActivationMouseEvent { get; set; }

Property Value

MouseActivationEvent

GuidItem

Gets or sets the Guid id that will be used to identify the notify icon when sending messages to it.

Declaration

cs-api-definition
[Browsable(true)]
public Guid GuidItem { get; set; }

Property Value

Guid

IsPopupOpen

Gets a value indicating whether a popup is open.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsPopupOpen { get; }

Property Value

bool

PopupActivationMouseEvent

Gets or sets the mouse action that must be performed over the notify icon to show a popup with PopupContent.

Declaration

cs-api-definition
[Browsable(true)]
public MouseActivationEvent PopupActivationMouseEvent { get; set; }

Property Value

MouseActivationEvent

PopupCloseMode

Gets or sets the mode in which the popup closes.

Declaration

cs-api-definition
[Browsable(true)]
public PopupCloseMode PopupCloseMode { get; set; }

Property Value

PopupCloseMode

PopupContent

Gets or sets the control that is set as the content of the popup which the notify icon shows when the PopupActivationMouseEvent is performed.

Declaration

cs-api-definition
[Browsable(true)]
public Control PopupContent { get; set; }

Property Value

Control

PopupHideAnimation

Gets or sets the animation played when hiding the popup.

Declaration

cs-api-definition
[Browsable(true)]
public NotifyIconAnimationType PopupHideAnimation { get; set; }

Property Value

NotifyIconAnimationType

PopupShowAnimation

Gets or sets the animation played when opening the popup.

Declaration

cs-api-definition
[Browsable(true)]
public NotifyIconAnimationType PopupShowAnimation { get; set; }

Property Value

NotifyIconAnimationType

PopupShowDuration

Gets or sets the amount of time in milliseconds after which the popup will begin to close automatically.

Declaration

cs-api-definition
[Browsable(true)]
public int PopupShowDuration { get; set; }

Property Value

int

ShowTrayIcon

Gets or sets whether the icon is visible in the notification area.

Declaration

cs-api-definition
[Browsable(true)]
public bool ShowTrayIcon { get; set; }

Property Value

bool

ThemeName

Gets or sets theme name.

Declaration

cs-api-definition
[Browsable(true)]
public string ThemeName { get; set; }

Property Value

string

TooltipText

Gets or sets the tooltip that will be shown when the mouse hovers over the notify icon.

Declaration

cs-api-definition
[Browsable(true)]
public string TooltipText { get; set; }

Property Value

string

TrayContextMenu

Gets or sets the context menu to be shown when the ContextMenuActivationMouseEvent is performed.

Declaration

cs-api-definition
[Browsable(true)]
public RadContextMenu TrayContextMenu { get; set; }

Property Value

RadContextMenu

TrayIcon

Gets or sets the icon to be displayed in the windows notification area.

Declaration

cs-api-definition
[Browsable(true)]
public Icon TrayIcon { get; set; }

Property Value

Icon

Methods

AddIcon()

Adds the notify icon to the Windows notification area.

Declaration

cs-api-definition
public void AddIcon()

Dispose(bool)

Disposes any resources this instance holds.

Declaration

cs-api-definition
protected override void Dispose(bool disposing)

Parameters

disposing

bool

Overrides Component.Dispose(bool)

GetUserNotificationState()

Checks the state of the computer for the current user to determine whether sending a notification is appropriate.

Declaration

cs-api-definition
public static UserNotificationState GetUserNotificationState()

Returns

UserNotificationState

The state of the computer for the current user.

HideBalloonTip()

Hides the balloon tip.

Declaration

cs-api-definition
public void HideBalloonTip()

HidePopup()

Hides the popup.

Declaration

cs-api-definition
public void HidePopup()

OnBalloonTipClicked()

Fires the BalloonTipClicked event.

Declaration

cs-api-definition
protected virtual void OnBalloonTipClicked()

OnBalloonTipClosed()

Fires the BalloonTipClosed event.

Declaration

cs-api-definition
protected virtual void OnBalloonTipClosed()

OnBalloonTipShown()

Fires the BalloonTipShown event.

Declaration

cs-api-definition
protected virtual void OnBalloonTipShown()

OnPopupOpened(EventArgs)

Fires the PopupOpened event.

Declaration

cs-api-definition
protected virtual void OnPopupOpened(EventArgs e)

Parameters

e

EventArgs

The event arguments.

OnPopupOpening(NotifyIconPopupOpeningEventArgs)

Fires the PopupOpening event.

Declaration

cs-api-definition
protected virtual void OnPopupOpening(NotifyIconPopupOpeningEventArgs e)

Parameters

e

NotifyIconPopupOpeningEventArgs

The event arguments.

OnSelected(NotifyIconSelectedEventArgs)

Fires the Selected event.

Declaration

cs-api-definition
protected virtual void OnSelected(NotifyIconSelectedEventArgs e)

Parameters

e

NotifyIconSelectedEventArgs

The event arguments.

OnTrayContextMenuOpened(EventArgs)

Fires the TrayContextMenuOpened event.

Declaration

cs-api-definition
protected virtual void OnTrayContextMenuOpened(EventArgs e)

Parameters

e

EventArgs

The event arguments.

OnTrayContextMenuOpening(CancelEventArgs)

Fires the TrayContextMenuOpening event.

Declaration

cs-api-definition
protected virtual void OnTrayContextMenuOpening(CancelEventArgs e)

Parameters

e

CancelEventArgs

The event arguments.

OnTrayIconMouseClick(MouseEventArgs)

Fires the TrayIconMouseClick event.

Declaration

cs-api-definition
protected virtual void OnTrayIconMouseClick(MouseEventArgs e)

Parameters

e

MouseEventArgs

The event arguments.

OnTrayIconMouseDoubleClick(MouseEventArgs)

Fires the TrayIconMouseDoubleClick event.

Declaration

cs-api-definition
protected virtual void OnTrayIconMouseDoubleClick(MouseEventArgs e)

Parameters

e

MouseEventArgs

The event arguments.

OnTrayIconMouseDown(MouseEventArgs)

Fires the TrayIconMouseDown event.

Declaration

cs-api-definition
protected virtual void OnTrayIconMouseDown(MouseEventArgs e)

Parameters

e

MouseEventArgs

The event arguments.

OnTrayIconMouseMove(MouseEventArgs)

Fires the TrayIconMouseMove event.

Declaration

cs-api-definition
protected virtual void OnTrayIconMouseMove(MouseEventArgs e)

Parameters

e

MouseEventArgs

The event arguments.

OnTrayIconMouseUp(MouseEventArgs)

Fires the TrayIconMouseUp event.

Declaration

cs-api-definition
protected virtual void OnTrayIconMouseUp(MouseEventArgs e)

Parameters

e

MouseEventArgs

The event arguments.

RemoveIcon()

Removes the icon from the Windows notification area.

Declaration

cs-api-definition
public void RemoveIcon()

ShowBalloonTip(int)

Shows a balloon tip with the settings defined in the BalloonTitle, BalloonTitle and BalloonIcon properties.

Declaration

cs-api-definition
public void ShowBalloonTip(int timeout = 10)

Parameters

timeout

int

The amount of seconds to wait before the balloon auto hides. The system minimum and maximum are 10 and 30 seconds. Note this parameter has effect only in Windows 2000 and Windows XP. More information here https://docs.microsoft.com/en-us/windows/win32/api/shellapi/ns-shellapi-notifyicondataa.

ShowBalloonTip(string, string, BalloonTipIcon, bool, int)

Shows a balloon tip.

Declaration

cs-api-definition
public void ShowBalloonTip(string title, string text, BalloonTipIcon icon, bool doNotPlaySound = false, int timeout = 10)

Parameters

title

string

The title of the balloon tip.

text

string

The text of the balloon tip.

icon

BalloonTipIcon

The icon of the balloon tip.

doNotPlaySound

bool

Whether sound should be played when showing the balloon tip.

timeout

int

The amount of seconds to wait before the balloon auto hides. The system minimum and maximum are 10 and 30 seconds. Note this parameter has effect only in Windows 2000 and Windows XP. More information here https://docs.microsoft.com/en-us/windows/win32/api/shellapi/ns-shellapi-notifyicondataa.

ShowBalloonTip(string, string, Icon, bool, int)

Shows a balloon tip.

Declaration

cs-api-definition
public void ShowBalloonTip(string title, string text, Icon icon, bool doNotPlaySound = false, int timeout = 10)

Parameters

title

string

The title of the balloon tip.

text

string

The text of the balloon tip.

icon

Icon

The icon of the balloon tip.

doNotPlaySound

bool

Whether sound should be played when showing the balloon tip.

timeout

int

The amount of seconds to wait before the balloon auto hides. The system minimum and maximum are 10 and 30 seconds. Note this parameter has effect only in Windows 2000 and Windows XP. More information here https://docs.microsoft.com/en-us/windows/win32/api/shellapi/ns-shellapi-notifyicondataa.

ShowPopup()

Shows the popup next to the notify icon, depending on edge of the screen where the taskbar is located.

Declaration

cs-api-definition
public void ShowPopup()

ShowPopup(Point)

Shows the popup at the provided location.

Declaration

cs-api-definition
public void ShowPopup(Point location)

Parameters

location

Point

The coordinates where the popup should be opened.

UpdateIcon()

Sends an update message to the notify icon.

Declaration

cs-api-definition
public void UpdateIcon()

~RadNotifyIcon()

Releases unmanaged resources and performs other cleanup operations before the RadNotifyIcon is reclaimed by garbage collection.

Declaration

cs-api-definition
protected ~RadNotifyIcon()

Events

BalloonTipClicked

Occurs when the user clicks on a balloon tip.

Declaration

cs-api-definition
public event EventHandler BalloonTipClicked

Event Value

EventHandler

BalloonTipClosed

Occurs when a balloon tip is closed.

Declaration

cs-api-definition
public event EventHandler BalloonTipClosed

Event Value

EventHandler

BalloonTipShown

Occurs when a balloon tip is shown.

Declaration

cs-api-definition
public event EventHandler BalloonTipShown

Event Value

EventHandler

PopupOpened

Occurs when the popup of the RadNotifyIcon is opened.

Declaration

cs-api-definition
public event EventHandler PopupOpened

Event Value

EventHandler

PopupOpening

Occurs before the popup of the RadNotifyIcon is opened.

Declaration

cs-api-definition
public event EventHandler<NotifyIconPopupOpeningEventArgs> PopupOpening

Event Value

EventHandler<NotifyIconPopupOpeningEventArgs>

Selected

Occurs when the user selects a RadNotifyIcon in the Windows notification area.

Declaration

cs-api-definition
public event EventHandler<NotifyIconSelectedEventArgs> Selected

Event Value

EventHandler<NotifyIconSelectedEventArgs>

TrayContextMenuOpened

Occurs when the context menu of the RadNotifyIcon is opened.

Declaration

cs-api-definition
public event EventHandler TrayContextMenuOpened

Event Value

EventHandler

TrayContextMenuOpening

Occurs before the context menu of the RadNotifyIcon is opened.

Declaration

cs-api-definition
public event CancelEventHandler TrayContextMenuOpening

Event Value

CancelEventHandler

TrayIconMouseClick

Occurs when the user clicks on the notify icon.

Declaration

cs-api-definition
public event MouseEventHandler TrayIconMouseClick

Event Value

MouseEventHandler

TrayIconMouseDoubleClick

Occurs when the user double clicks on the notify icon.

Declaration

cs-api-definition
public event MouseEventHandler TrayIconMouseDoubleClick

Event Value

MouseEventHandler

TrayIconMouseDown

Occurs when the user presses a mouse button over the notify icon.

Declaration

cs-api-definition
public event MouseEventHandler TrayIconMouseDown

Event Value

MouseEventHandler

TrayIconMouseMove

Occurs when the user moves the mouse over the notify icon.

Declaration

cs-api-definition
public event MouseEventHandler TrayIconMouseMove

Event Value

MouseEventHandler

TrayIconMouseUp

Occurs when the user releases a mouse button over the notify icon.

Declaration

cs-api-definition
public event MouseEventHandler TrayIconMouseUp

Event Value

MouseEventHandler