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 and balloon notifications.

Inheritance
System.Object
RadNotifyIcon
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

[TelerikToolboxCategory("Containers")]
public class RadNotifyIcon : FrameworkElement, IDisposable

Constructors

RadNotifyIcon()

Initializes a new instance of the RadNotifyIcon class.

Declaration
public RadNotifyIcon()

Fields

BalloonIconProperty

Identifies the BalloonIcon dependency property.

Declaration
public static readonly DependencyProperty BalloonIconProperty
Field Value
System.Windows.DependencyProperty

BalloonIconSourceProperty

Identifies the BalloonIconSource dependency property.

Declaration
public static readonly DependencyProperty BalloonIconSourceProperty
Field Value
System.Windows.DependencyProperty

BalloonTextProperty

Identifies the BalloonText dependency property.

Declaration
public static readonly DependencyProperty BalloonTextProperty
Field Value
System.Windows.DependencyProperty

BalloonTitleProperty

Identifies the BalloonTitle dependency property.

Declaration
public static readonly DependencyProperty BalloonTitleProperty
Field Value
System.Windows.DependencyProperty

ContextMenuActivationMouseEventProperty

Identifies the ContextMenuActivationMouseEvent dependency property.

Declaration
public static readonly DependencyProperty ContextMenuActivationMouseEventProperty
Field Value
System.Windows.DependencyProperty

GuidItemProperty

Identifies the GuidItem dependency property.

Declaration
public static readonly DependencyProperty GuidItemProperty
Field Value
System.Windows.DependencyProperty

PopupActivationMouseEventProperty

Identifies the PopupActivationMouseEvent dependency property.

Declaration
public static readonly DependencyProperty PopupActivationMouseEventProperty
Field Value
System.Windows.DependencyProperty

PopupCloseModeProperty

Identifies the PopupCloseMode dependency property.

Declaration
public static readonly DependencyProperty PopupCloseModeProperty
Field Value
System.Windows.DependencyProperty

PopupContentProperty

Identifies the PopupContent dependency property.

Declaration
public static readonly DependencyProperty PopupContentProperty
Field Value
System.Windows.DependencyProperty

PopupContentTemplateProperty

Identifies the PopupContentTemplate dependency property.

Declaration
public static readonly DependencyProperty PopupContentTemplateProperty
Field Value
System.Windows.DependencyProperty

PopupShowDurationProperty

Identifies the PopupShowDuration dependency property.

Declaration
public static readonly DependencyProperty PopupShowDurationProperty
Field Value
System.Windows.DependencyProperty

ShowTrayIconProperty

Identifies the ShowTrayIcon dependency property.

Declaration
public static readonly DependencyProperty ShowTrayIconProperty
Field Value
System.Windows.DependencyProperty

TooltipContentProperty

Identifies the TooltipContent dependency property.

Declaration
public static readonly DependencyProperty TooltipContentProperty
Field Value
System.Windows.DependencyProperty

TooltipContentTemplateProperty

Identifies the TooltipContentTemplate dependency property.

Declaration
public static readonly DependencyProperty TooltipContentTemplateProperty
Field Value
System.Windows.DependencyProperty

TrayContextMenuProperty

Identifies the TrayContextMenu dependency property.

Declaration
public static readonly DependencyProperty TrayContextMenuProperty
Field Value
System.Windows.DependencyProperty

TrayIconProperty

Identifies the TrayIcon dependency property.

Declaration
public static readonly DependencyProperty TrayIconProperty
Field Value
System.Windows.DependencyProperty

TrayIconSourceProperty

Identifies the TrayIconSource dependency property.

Declaration
public static readonly DependencyProperty TrayIconSourceProperty
Field Value
System.Windows.DependencyProperty

UseNativeTooltipProperty

Identifies the UseNativeTooltip dependency property.

Declaration
public static readonly DependencyProperty UseNativeTooltipProperty
Field Value
System.Windows.DependencyProperty

Properties

BalloonIcon

Gets or sets the icon of the balloon tip to be show when the ShowBalloonTip(Int32) method is called. This is a dependency property.

Declaration
public Icon BalloonIcon { get; set; }
Property Value
System.Drawing.Icon

BalloonIconSource

Gets or sets the icon of the balloon tip to be show when the ShowBalloonTip(Int32) method is called. This is a dependency property.

Declaration
public ImageSource BalloonIconSource { get; set; }
Property Value
System.Windows.Media.ImageSource

BalloonText

Gets or sets the text of the balloon tip to be show when the ShowBalloonTip(Int32) method is called. This is a dependency property.

Declaration
public string BalloonText { get; set; }
Property Value
System.String

BalloonTitle

Gets or sets the title of the balloon tip to be show when the ShowBalloonTip(Int32) method is called. This is a dependency property.

Declaration
public string BalloonTitle { get; set; }
Property Value
System.String

ContextMenuActivationMouseEvent

Gets or sets the mouse action that must be performed over the notify icon to show the TrayContextMenu. This is a dependency property.

Declaration
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. This is a dependency property.

Declaration
public Guid GuidItem { get; set; }
Property Value
System.Guid

IsPopupOpen

Gets a value indicating whether a popup is open.

Declaration
public bool IsPopupOpen { get; }
Property Value
System.Boolean

IsTooltipOpen

Gets a value indicating whether a custom tooltip is open.

Declaration
public bool IsTooltipOpen { get; }
Property Value
System.Boolean

PopupActivationMouseEvent

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

Declaration
public MouseActivationEvent PopupActivationMouseEvent { get; set; }
Property Value
MouseActivationEvent

PopupCloseMode

Gets or sets the mode in which the popup closes. This is a dependency property.

Declaration
public PopupCloseMode PopupCloseMode { get; set; }
Property Value
PopupCloseMode

PopupContent

Gets or sets the content of the popup that the notify icon shows when the PopupActivationMouseEvent is performed. This is a dependency property.

Declaration
public object PopupContent { get; set; }
Property Value
System.Object

PopupContentTemplate

Gets or sets the content template for the popup that the notify icon shows when the PopupActivationMouseEvent is performed. This is a dependency property.

Declaration
public DataTemplate PopupContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

PopupHideAnimation

Gets or sets the animation played when hiding the popup.

Declaration
public RadAnimation PopupHideAnimation { get; set; }
Property Value
RadAnimation

PopupShowAnimation

Gets or sets the animation played when opening the popup.

Declaration
public RadAnimation PopupShowAnimation { get; set; }
Property Value
RadAnimation

PopupShowDuration

Gets or sets the amount of time in milliseconds after which the popup will begin to close automatically. This is a dependency property.

Declaration
public int PopupShowDuration { get; set; }
Property Value
System.Int32

ShowTrayIcon

Gets or sets whether the icon is visible in the notification area. This is a dependency property.

Declaration
public bool ShowTrayIcon { get; set; }
Property Value
System.Boolean

TooltipContent

Gets or sets the content of the tooltip that will be shown when the mouse hovers over the notify icon. This is a dependency property.

Declaration
public object TooltipContent { get; set; }
Property Value
System.Object

TooltipContentTemplate

Gets or sets the content template for the tooltip that will be shown when the mouse hovers over the notify icon. This is a dependency property.

Declaration
public DataTemplate TooltipContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

TrayContextMenu

Gets or sets the context menu to be shown when the ContextMenuActivationMouseEvent is performed. This is a dependency property.

Declaration
public RadContextMenu TrayContextMenu { get; set; }
Property Value
RadContextMenu

TrayIcon

Gets or sets the icon to be displayed in the windows notification area. This is a dependency property.

Declaration
public Icon TrayIcon { get; set; }
Property Value
System.Drawing.Icon

TrayIconSource

Gets or sets the icon to be displayed in the windows notification area. This is a dependency property.

Declaration
public ImageSource TrayIconSource { get; set; }
Property Value
System.Windows.Media.ImageSource

UseNativeTooltip

Gets or sets whether a native tooltip [true] or the TooltipContent and/or TooltipContentTemplate [false] will be shown when the mouse hovers over the notify icon. If set to [true] the TooltipContent property should be set to a string value. This is a dependency property.

Declaration
public bool UseNativeTooltip { get; set; }
Property Value
System.Boolean

Methods

AddIcon()

Adds the notify icon to the Windows notification area.

Declaration
public void AddIcon()

Dispose()

Disposes any resources this instance holds.

Declaration
public void Dispose()

Dispose(Boolean)

Disposes any resources this instance holds.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
System.Boolean disposing

Finalize()

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

Declaration
protected override void Finalize()

GetUserNotificationState()

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

Declaration
public static UserNotificationState GetUserNotificationState()
Returns
UserNotificationState

The state of the computer for the current user.

HideBalloonTip()

Hides the balloon tip.

Declaration
public void HideBalloonTip()

HidePopup()

Hides the popup.

Declaration
public void HidePopup()

MeasureOverride(Size)

Measurement override. Implement your size-to-content logic here.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
System.Windows.Size availableSize

Available size that parent can give to the child.
Returns
System.Windows.Size

Desired Size of the control, given available size passed as parameter.

OnBalloonTipClicked()

Fires the BalloonTipClicked event.

Declaration
protected virtual void OnBalloonTipClicked()

OnBalloonTipClosed()

Fires the BalloonTipClosed event.

Declaration
protected virtual void OnBalloonTipClosed()

OnBalloonTipShown()

Fires the BalloonTipShown event.

Declaration
protected virtual void OnBalloonTipShown()

OnPopupOpened(EventArgs)

Fires the PopupOpened event.

Declaration
protected virtual void OnPopupOpened(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

OnPopupOpening(NotifyIconPopupOpeningEventArgs)

Fires the PopupOpening event.

Declaration
protected virtual void OnPopupOpening(NotifyIconPopupOpeningEventArgs e)
Parameters
NotifyIconPopupOpeningEventArgs e

The event arguments.

OnPreviewTooltipOpened(CancelEventArgs)

Fires the PreviewTooltipOpened event.

Declaration
protected virtual void OnPreviewTooltipOpened(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

The event arguments.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Notification that a specified property has been changed.

Declaration
protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
System.Windows.DependencyPropertyChangedEventArgs e

EventArgs that contains the property, metadata, old value, and new value for this change.

OnSelected(NotifyIconSelectedEventArgs)

Fires the Selected event.

Declaration
protected virtual void OnSelected(NotifyIconSelectedEventArgs e)
Parameters
NotifyIconSelectedEventArgs e

The event arguments.

OnTooltipOpened(EventArgs)

Fires the TooltipOpened event.

Declaration
protected virtual void OnTooltipOpened(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

OnTrayContextMenuOpened(EventArgs)

Fires the TrayContextMenuOpened event.

Declaration
protected virtual void OnTrayContextMenuOpened(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

OnTrayContextMenuOpening(CancelEventArgs)

Fires the TrayContextMenuOpening event.

Declaration
protected virtual void OnTrayContextMenuOpening(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

The event arguments.

OnTrayIconMouseClick(MouseButtonEventArgs)

Fires the TrayIconMouseClick event.

Declaration
protected virtual void OnTrayIconMouseClick(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The event arguments.

OnTrayIconMouseDoubleClick(MouseButtonEventArgs)

Fires the TrayIconMouseDoubleClick event.

Declaration
protected virtual void OnTrayIconMouseDoubleClick(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The event arguments.

OnTrayIconMouseDown(MouseButtonEventArgs)

Fires the TrayIconMouseDown event.

Declaration
protected virtual void OnTrayIconMouseDown(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The event arguments.

OnTrayIconMouseMove(MouseEventArgs)

Fires the TrayIconMouseMove event.

Declaration
protected virtual void OnTrayIconMouseMove(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The event arguments.

OnTrayIconMouseUp(MouseButtonEventArgs)

Fires the TrayIconMouseUp event.

Declaration
protected virtual void OnTrayIconMouseUp(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The event arguments.

RemoveIcon()

Removes the icon from the Windows notification area.

Declaration
public void RemoveIcon()

ShowBalloonTip(Int32)

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

Declaration
public void ShowBalloonTip(int timeout = 10)
Parameters
System.Int32 timeout

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, Boolean, Boolean, Int32)

Shows a balloon tip.

Declaration
public void ShowBalloonTip(string title, string text, Icon icon, bool useLargeIcon = true, bool doNotPlaySound = false, int timeout = 10)
Parameters
System.String title

The title of the balloon tip.
System.String text

The text of the balloon tip.
System.Drawing.Icon icon

The icon of the balloon tip.
System.Boolean useLargeIcon

Whether the large version of the provided icon should be used.
System.Boolean doNotPlaySound

Whether sound should be played when showing the balloon tip.
System.Int32 timeout

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, Boolean, Int32)

Shows a balloon tip.

Declaration
public void ShowBalloonTip(string title, string text, BalloonTipIcon icon, bool doNotPlaySound = false, int timeout = 10)
Parameters
System.String title

The title of the balloon tip.
System.String text

The text of the balloon tip.
BalloonTipIcon icon

The icon of the balloon tip.
System.Boolean doNotPlaySound

Whether sound should be played when showing the balloon tip.
System.Int32 timeout

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
public void ShowPopup()

ShowPopup(Point)

Shows the popup at the provided location.

Declaration
public void ShowPopup(Point location)
Parameters
System.Windows.Point location

The coordinates where the popup should be opened.

UpdateIcon()

Sends an update message to the notify icon.

Declaration
public void UpdateIcon()

Events

BalloonTipClicked

Occurs when the user clicks on a balloon tip.

Declaration
public event EventHandler BalloonTipClicked
Event Type
System.EventHandler

BalloonTipClosed

Occurs when a balloon tip is closed.

Declaration
public event EventHandler BalloonTipClosed
Event Type
System.EventHandler

BalloonTipShown

Occurs when a balloon tip is shown.

Declaration
public event EventHandler BalloonTipShown
Event Type
System.EventHandler

PopupOpened

Occurs when the popup of the RadNotifyIcon is opened.

Declaration
public event EventHandler PopupOpened
Event Type
System.EventHandler

PopupOpening

Occurs before the popup of the RadNotifyIcon is opened.

Declaration
public event EventHandler<NotifyIconPopupOpeningEventArgs> PopupOpening
Event Type
System.EventHandler<NotifyIconPopupOpeningEventArgs>

PreviewTooltipOpened

Occurs before the custom tooltip of the RadNotifyIcon is opened.

Declaration
public event CancelEventHandler PreviewTooltipOpened
Event Type
System.ComponentModel.CancelEventHandler

Selected

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

Declaration
public event EventHandler<NotifyIconSelectedEventArgs> Selected
Event Type
System.EventHandler<NotifyIconSelectedEventArgs>

TooltipOpened

Occurs when the custom tooltip of the RadNotifyIcon is opened.

Declaration
public event EventHandler TooltipOpened
Event Type
System.EventHandler

TrayContextMenuOpened

Occurs when the context menu of the RadNotifyIcon is opened.

Declaration
public event EventHandler TrayContextMenuOpened
Event Type
System.EventHandler

TrayContextMenuOpening

Occurs before the context menu of the RadNotifyIcon is opened.

Declaration
public event CancelEventHandler TrayContextMenuOpening
Event Type
System.ComponentModel.CancelEventHandler

TrayIconMouseClick

Occurs when the user clicks on the notify icon.

Declaration
public event MouseButtonEventHandler TrayIconMouseClick
Event Type
System.Windows.Input.MouseButtonEventHandler

TrayIconMouseDoubleClick

Occurs when the user double clicks on the notify icon.

Declaration
public event MouseButtonEventHandler TrayIconMouseDoubleClick
Event Type
System.Windows.Input.MouseButtonEventHandler

TrayIconMouseDown

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

Declaration
public event MouseButtonEventHandler TrayIconMouseDown
Event Type
System.Windows.Input.MouseButtonEventHandler

TrayIconMouseMove

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

Declaration
public event MouseEventHandler TrayIconMouseMove
Event Type
System.Windows.Input.MouseEventHandler

TrayIconMouseUp

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

Declaration
public event MouseButtonEventHandler TrayIconMouseUp
Event Type
System.Windows.Input.MouseButtonEventHandler

Extension Methods