Class

RadNotifyIcon

Initializes a new instance of the RadNotifyIcon class.

Declaration

public RadNotifyIcon()

Identifies the BalloonIcon dependency property.

Declaration

public static readonly DependencyProperty BalloonIconProperty

Field Value

Identifies the BalloonIconSource dependency property.

Declaration

public static readonly DependencyProperty BalloonIconSourceProperty

Field Value

Identifies the BalloonText dependency property.

Declaration

public static readonly DependencyProperty BalloonTextProperty

Field Value

Identifies the BalloonTitle dependency property.

Declaration

public static readonly DependencyProperty BalloonTitleProperty

Field Value

Identifies the ContextMenuActivationMouseEvent dependency property.

Declaration

public static readonly DependencyProperty ContextMenuActivationMouseEventProperty

Field Value

Identifies the GuidItem dependency property.

Declaration

public static readonly DependencyProperty GuidItemProperty

Field Value

Identifies the PopupActivationMouseEvent dependency property.

Declaration

public static readonly DependencyProperty PopupActivationMouseEventProperty

Field Value

Identifies the PopupCloseMode dependency property.

Declaration

public static readonly DependencyProperty PopupCloseModeProperty

Field Value

Identifies the PopupContent dependency property.

Declaration

public static readonly DependencyProperty PopupContentProperty

Field Value

Identifies the PopupContentTemplate dependency property.

Declaration

public static readonly DependencyProperty PopupContentTemplateProperty

Field Value

Identifies the PopupShowDuration dependency property.

Declaration

public static readonly DependencyProperty PopupShowDurationProperty

Field Value

Identifies the ShowTrayIcon dependency property.

Declaration

public static readonly DependencyProperty ShowTrayIconProperty

Field Value

Identifies the TooltipContent dependency property.

Declaration

public static readonly DependencyProperty TooltipContentProperty

Field Value

Identifies the TooltipContentTemplate dependency property.

Declaration

public static readonly DependencyProperty TooltipContentTemplateProperty

Field Value

Identifies the TrayContextMenu dependency property.

Declaration

public static readonly DependencyProperty TrayContextMenuProperty

Field Value

Identifies the TrayIcon dependency property.

Declaration

public static readonly DependencyProperty TrayIconProperty

Field Value

Identifies the TrayIconSource dependency property.

Declaration

public static readonly DependencyProperty TrayIconSourceProperty

Field Value

Identifies the UseNativeTooltip dependency property.

Declaration

public static readonly DependencyProperty UseNativeTooltipProperty

Field Value

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

Declaration

public Icon BalloonIcon { get; set; }

Property Value

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

Declaration

public ImageSource BalloonIconSource { get; set; }

Property Value

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

Declaration

public string BalloonText { get; set; }

Property Value

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

Declaration

public string BalloonTitle { get; set; }

Property Value

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

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

Gets a value indicating whether a popup is open.

Declaration

public bool IsPopupOpen { get; }

Property Value

Gets a value indicating whether a custom tooltip is open.

Declaration

public bool IsTooltipOpen { get; }

Property Value

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

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

Declaration

public PopupCloseMode PopupCloseMode { get; set; }

Property Value

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

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

Gets or sets the animation played when hiding the popup.

Declaration

public RadAnimation PopupHideAnimation { get; set; }

Property Value

Gets or sets the animation played when opening the popup.

Declaration

public RadAnimation PopupShowAnimation { get; set; }

Property Value

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

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

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

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

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

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

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

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

Adds the notify icon to the Windows notification area.

Declaration

public void AddIcon()

Disposes any resources this instance holds.

Declaration

public void Dispose()

Implements IDisposable.Dispose()

Disposes any resources this instance holds.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

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

Declaration

protected override void Finalize()

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

Declaration

public static UserNotificationState GetUserNotificationState()

Returns

Hides the balloon tip.

Declaration

public void HideBalloonTip()

Hides the popup.

Declaration

public void HidePopup()

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

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Returns

Fires the BalloonTipClicked event.

Declaration

protected virtual void OnBalloonTipClicked()

Fires the BalloonTipClosed event.

Declaration

protected virtual void OnBalloonTipClosed()

Fires the BalloonTipShown event.

Declaration

protected virtual void OnBalloonTipShown()

Fires the PopupOpened event.

Declaration

protected virtual void OnPopupOpened(EventArgs e)

Parameters

Fires the PopupOpening event.

Declaration

protected virtual void OnPopupOpening(NotifyIconPopupOpeningEventArgs e)

Parameters

Fires the PreviewTooltipOpened event.

Declaration

protected virtual void OnPreviewTooltipOpened(CancelEventArgs e)

Parameters

Notification that a specified property has been changed.

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

Fires the Selected event.

Declaration

protected virtual void OnSelected(NotifyIconSelectedEventArgs e)

Parameters

Fires the TooltipOpened event.

Declaration

protected virtual void OnTooltipOpened(EventArgs e)

Parameters

Fires the TrayContextMenuOpened event.

Declaration

protected virtual void OnTrayContextMenuOpened(EventArgs e)

Parameters

Fires the TrayContextMenuOpening event.

Declaration

protected virtual void OnTrayContextMenuOpening(CancelEventArgs e)

Parameters

Fires the TrayIconMouseClick event.

Declaration

protected virtual void OnTrayIconMouseClick(MouseButtonEventArgs e)

Parameters

Fires the TrayIconMouseDoubleClick event.

Declaration

protected virtual void OnTrayIconMouseDoubleClick(MouseButtonEventArgs e)

Parameters

Fires the TrayIconMouseDown event.

Declaration

protected virtual void OnTrayIconMouseDown(MouseButtonEventArgs e)

Parameters

Fires the TrayIconMouseMove event.

Declaration

protected virtual void OnTrayIconMouseMove(MouseEventArgs e)

Parameters

Fires the TrayIconMouseUp event.

Declaration

protected virtual void OnTrayIconMouseUp(MouseButtonEventArgs e)

Parameters

Removes the icon from the Windows notification area.

Declaration

public void RemoveIcon()

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

Declaration

public void ShowBalloonTip(int timeout = 10)

Parameters

Shows a balloon tip.

Declaration

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

Parameters

Shows a balloon tip.

Declaration

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

Parameters

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

Declaration

public void ShowPopup()

Shows the popup at the provided location.

Declaration

public void ShowPopup(Point location)

Parameters

Sends an update message to the notify icon.

Declaration

public void UpdateIcon()

Occurs when the user clicks on a balloon tip.

Declaration

public event EventHandler BalloonTipClicked

Event Value

Occurs when a balloon tip is closed.

Declaration

public event EventHandler BalloonTipClosed

Event Value

Occurs when a balloon tip is shown.

Declaration

public event EventHandler BalloonTipShown

Event Value

Occurs when the popup of the RadNotifyIcon is opened.

Declaration

public event EventHandler PopupOpened

Event Value

Occurs before the popup of the RadNotifyIcon is opened.

Declaration

public event EventHandler<NotifyIconPopupOpeningEventArgs> PopupOpening

Event Value

Occurs before the custom tooltip of the RadNotifyIcon is opened.

Declaration

public event CancelEventHandler PreviewTooltipOpened

Event Value

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

Declaration

public event EventHandler<NotifyIconSelectedEventArgs> Selected

Event Value

Occurs when the custom tooltip of the RadNotifyIcon is opened.

Declaration

public event EventHandler TooltipOpened

Event Value

Occurs when the context menu of the RadNotifyIcon is opened.

Declaration

public event EventHandler TrayContextMenuOpened

Event Value

Occurs before the context menu of the RadNotifyIcon is opened.

Declaration

public event CancelEventHandler TrayContextMenuOpening

Event Value

Occurs when the user clicks on the notify icon.

Declaration

public event MouseButtonEventHandler TrayIconMouseClick

Event Value

Occurs when the user double clicks on the notify icon.

Declaration

public event MouseButtonEventHandler TrayIconMouseDoubleClick

Event Value

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

Declaration

public event MouseButtonEventHandler TrayIconMouseDown

Event Value

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

Declaration

public event MouseEventHandler TrayIconMouseMove

Event Value

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

Declaration

public event MouseButtonEventHandler TrayIconMouseUp

Event Value