Class TaskbarIcon
A WPF proxy to for a taskbar icon (NotifyIcon) that sits in the system's taskbar notification area ("system tray").
Inheritance
Implements
Inherited Members
Namespace: Simplic.Framework.Core.TaskbarNotification
Assembly: Simplic.Framework.Base.dll
Syntax
public class TaskbarIcon : FrameworkElement, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient, IDisposable
Constructors
| Improve this Doc View SourceTaskbarIcon()
Inits the taskbar icon and registers a message listener in order to receive events from the taskbar area.
Declaration
public TaskbarIcon()
Fields
| Improve this Doc View SourceBalloonClosingEvent
BalloonClosing Attached Routed Event
Declaration
public static readonly RoutedEvent BalloonClosingEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
BalloonShowingEvent
BalloonShowing Attached Routed Event
Declaration
public static readonly RoutedEvent BalloonShowingEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
CategoryName
Category name that is set on designer properties.
Declaration
public const string CategoryName = "NotifyIcon"
Field Value
Type | Description |
---|---|
System.String |
CustomBalloonProperty
Maintains a currently displayed custom balloon.
Declaration
public static readonly DependencyProperty CustomBalloonProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
DoubleClickCommandParameterProperty
Command parameter for the DoubleClickCommand.
Declaration
public static readonly DependencyProperty DoubleClickCommandParameterProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
DoubleClickCommandProperty
Associates a command that is being executed if the tray icon is being double clicked.
Declaration
public static readonly DependencyProperty DoubleClickCommandProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
DoubleClickCommandTargetProperty
The target of the command that is fired if the notify icon is double clicked.
Declaration
public static readonly DependencyProperty DoubleClickCommandTargetProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
IconSourceProperty
Resolves an image source and updates the Icon property accordingly.
Declaration
public static readonly DependencyProperty IconSourceProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
LeftClickCommandParameterProperty
Command parameter for the LeftClickCommand.
Declaration
public static readonly DependencyProperty LeftClickCommandParameterProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
LeftClickCommandProperty
Associates a command that is being executed if the tray icon is being double clicked.
Declaration
public static readonly DependencyProperty LeftClickCommandProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
LeftClickCommandTargetProperty
The target of the command that is fired if the notify icon is clicked.
Declaration
public static readonly DependencyProperty LeftClickCommandTargetProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
MenuActivationProperty
Defines what mouse events display the context menu. Defaults to RightClick.
Declaration
public static readonly DependencyProperty MenuActivationProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
ParentTaskbarIconProperty
An attached property that is assigned to displayed UI elements (balloos, tooltips, context menus), and that can be used to bind to this control. The attached property is being derived, so binding is quite straightforward:
Declaration
public static readonly DependencyProperty ParentTaskbarIconProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
PopupActivationProperty
Declaration
public static readonly DependencyProperty PopupActivationProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
PopupOpenedEvent
PopupOpened Attached Routed Event
Declaration
public static readonly RoutedEvent PopupOpenedEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
PreviewTrayContextMenuOpenEvent
PreviewTrayContextMenuOpen Routed Event
Declaration
public static readonly RoutedEvent PreviewTrayContextMenuOpenEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
PreviewTrayPopupOpenEvent
PreviewTrayPopupOpen Routed Event
Declaration
public static readonly RoutedEvent PreviewTrayPopupOpenEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
PreviewTrayToolTipCloseEvent
PreviewTrayToolTipClose Routed Event
Declaration
public static readonly RoutedEvent PreviewTrayToolTipCloseEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
PreviewTrayToolTipOpenEvent
PreviewTrayToolTipOpen Routed Event
Declaration
public static readonly RoutedEvent PreviewTrayToolTipOpenEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
ToolTipCloseEvent
ToolTipClose Attached Routed Event
Declaration
public static readonly RoutedEvent ToolTipCloseEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
ToolTipOpenedEvent
ToolTipOpened Attached Routed Event
Declaration
public static readonly RoutedEvent ToolTipOpenedEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
ToolTipTextProperty
A tooltip text that is being displayed if no custom System.Windows.Controls.ToolTip was set or if custom tooltips are not supported.
Declaration
public static readonly DependencyProperty ToolTipTextProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
TrayBalloonTipClickedEvent
TrayBalloonTipClicked Routed Event
Declaration
public static readonly RoutedEvent TrayBalloonTipClickedEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayBalloonTipClosedEvent
TrayBalloonTipClosed Routed Event
Declaration
public static readonly RoutedEvent TrayBalloonTipClosedEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayBalloonTipShownEvent
TrayBalloonTipShown Routed Event
Declaration
public static readonly RoutedEvent TrayBalloonTipShownEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayContextMenuOpenEvent
TrayContextMenuOpen Routed Event
Declaration
public static readonly RoutedEvent TrayContextMenuOpenEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayLeftMouseDownEvent
TrayLeftMouseDown Routed Event
Declaration
public static readonly RoutedEvent TrayLeftMouseDownEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayLeftMouseUpEvent
TrayLeftMouseUp Routed Event
Declaration
public static readonly RoutedEvent TrayLeftMouseUpEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayMiddleMouseDownEvent
TrayMiddleMouseDown Routed Event
Declaration
public static readonly RoutedEvent TrayMiddleMouseDownEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayMiddleMouseUpEvent
TrayMiddleMouseUp Routed Event
Declaration
public static readonly RoutedEvent TrayMiddleMouseUpEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayMouseDoubleClickEvent
TrayMouseDoubleClick Routed Event
Declaration
public static readonly RoutedEvent TrayMouseDoubleClickEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayMouseMoveEvent
TrayMouseMove Routed Event
Declaration
public static readonly RoutedEvent TrayMouseMoveEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayPopupOpenEvent
TrayPopupOpen Routed Event
Declaration
public static readonly RoutedEvent TrayPopupOpenEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayPopupProperty
A control that is displayed as a popup when the taskbar icon is clicked.
Declaration
public static readonly DependencyProperty TrayPopupProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
TrayPopupResolvedProperty
A read-only dependency property that returns the System.Windows.Controls.Primitives.Popup that is being displayed in the taskbar area based on a user action.
Declaration
public static readonly DependencyProperty TrayPopupResolvedProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
TrayRightMouseDownEvent
TrayRightMouseDown Routed Event
Declaration
public static readonly RoutedEvent TrayRightMouseDownEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayRightMouseUpEvent
TrayRightMouseUp Routed Event
Declaration
public static readonly RoutedEvent TrayRightMouseUpEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayToolTipCloseEvent
TrayToolTipClose Routed Event
Declaration
public static readonly RoutedEvent TrayToolTipCloseEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayToolTipOpenEvent
TrayToolTipOpen Routed Event
Declaration
public static readonly RoutedEvent TrayToolTipOpenEvent
Field Value
Type | Description |
---|---|
System.Windows.RoutedEvent |
TrayToolTipProperty
A custom UI element that is displayed as a tooltip if the user hovers over the taskbar icon. Works only with Vista and above. Accordingly, you should make sure that the ToolTipText property is set as well.
Declaration
public static readonly DependencyProperty TrayToolTipProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
TrayToolTipResolvedProperty
A read-only dependency property that returns the System.Windows.Controls.ToolTip that is being displayed.
Declaration
public static readonly DependencyProperty TrayToolTipResolvedProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Properties
| Improve this Doc View SourceCustomBalloon
A custom popup that is being displayed in the tray area in order to display messages to the user.
Declaration
public Popup CustomBalloon { get; }
Property Value
Type | Description |
---|---|
System.Windows.Controls.Primitives.Popup |
DoubleClickCommand
A property wrapper for the DoubleClickCommandProperty
dependency property:
Associates a command that is being executed if the tray icon is being
double clicked.
Declaration
public ICommand DoubleClickCommand { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Input.ICommand |
DoubleClickCommandParameter
A property wrapper for the DoubleClickCommandParameterProperty
dependency property:
Command parameter for the DoubleClickCommand.
Declaration
public object DoubleClickCommandParameter { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
DoubleClickCommandTarget
A property wrapper for the DoubleClickCommandTargetProperty
dependency property:
The target of the command that is fired if the notify icon is double clicked.
Declaration
public IInputElement DoubleClickCommandTarget { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.IInputElement |
Icon
Gets or sets the icon to be displayed. This is not a dependency property - if you want to assign the property through XAML, please use the IconSource dependency property.
Declaration
[Browsable(false)]
public Icon Icon { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Icon |
IconSource
A property wrapper for the IconSourceProperty
dependency property:
Resolves an image source and updates the Icon property accordingly.
Declaration
public ImageSource IconSource { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.ImageSource |
IsDisposed
Set to true as soon as Dispose
has been invoked.
Declaration
public bool IsDisposed { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsTaskbarIconCreated
Indicates whether the taskbar icon has been created or not.
Declaration
public bool IsTaskbarIconCreated { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
LeftClickCommand
A property wrapper for the LeftClickCommandProperty
dependency property:
Associates a command that is being executed if the tray icon is being
left-clicked.
Declaration
public ICommand LeftClickCommand { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Input.ICommand |
LeftClickCommandParameter
A property wrapper for the LeftClickCommandParameterProperty
dependency property:
Command parameter for the LeftClickCommand.
Declaration
public object LeftClickCommandParameter { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
LeftClickCommandTarget
A property wrapper for the LeftClickCommandTargetProperty
dependency property:
The target of the command that is fired if the notify icon is clicked.
Declaration
public IInputElement LeftClickCommandTarget { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.IInputElement |
MenuActivation
A property wrapper for the MenuActivationProperty
dependency property:
Defines what mouse events display the context menu.
Defaults to RightClick.
Declaration
public PopupActivationMode MenuActivation { get; set; }
Property Value
Type | Description |
---|---|
PopupActivationMode |
PopupActivation
A property wrapper for the PopupActivationProperty
dependency property:
Defines what mouse events trigger the TrayPopup.
Default is LeftClick.
Declaration
public PopupActivationMode PopupActivation { get; set; }
Property Value
Type | Description |
---|---|
PopupActivationMode |
SupportsCustomToolTips
Indicates whether custom tooltips are supported, which depends on the OS. Windows Vista or higher is required in order to support this feature.
Declaration
public bool SupportsCustomToolTips { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ToolTipText
A property wrapper for the ToolTipTextProperty
dependency property:
A tooltip text that is being displayed if no custom System.Windows.Controls.ToolTip
was set or if custom tooltips are not supported.
Declaration
public string ToolTipText { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TrayPopup
A property wrapper for the TrayPopupProperty
dependency property:
A control that is displayed as a popup when the taskbar icon is clicked.
Declaration
public UIElement TrayPopup { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.UIElement |
TrayPopupResolved
Gets the TrayPopupResolved property. Returns a System.Windows.Controls.Primitives.Popup which is either the TrayPopup control itself or a System.Windows.Controls.Primitives.Popup control that contains the TrayPopup.
Declaration
public Popup TrayPopupResolved { get; }
Property Value
Type | Description |
---|---|
System.Windows.Controls.Primitives.Popup |
TrayToolTip
A property wrapper for the TrayToolTipProperty
dependency property:
A custom UI element that is displayed as a tooltip if the user hovers over the taskbar icon.
Works only with Vista and above. Accordingly, you should make sure that
the ToolTipText property is set as well.
Declaration
public UIElement TrayToolTip { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.UIElement |
TrayToolTipResolved
Gets the TrayToolTipResolved property. Returns a System.Windows.Controls.ToolTip control that was created in order to display either TrayToolTip or ToolTipText.
Declaration
[Browsable(true)]
[Bindable(true)]
public ToolTip TrayToolTipResolved { get; }
Property Value
Type | Description |
---|---|
System.Windows.Controls.ToolTip |
Methods
| Improve this Doc View SourceAddBalloonClosingHandler(DependencyObject, RoutedEventHandler)
Adds a handler for the BalloonClosing attached event
Declaration
public static void AddBalloonClosingHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be added |
AddBalloonShowingHandler(DependencyObject, RoutedEventHandler)
Adds a handler for the BalloonShowing attached event
Declaration
public static void AddBalloonShowingHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be added |
AddPopupOpenedHandler(DependencyObject, RoutedEventHandler)
Adds a handler for the PopupOpened attached event
Declaration
public static void AddPopupOpenedHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be added |
AddToolTipCloseHandler(DependencyObject, RoutedEventHandler)
Adds a handler for the ToolTipClose attached event
Declaration
public static void AddToolTipCloseHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be added |
AddToolTipOpenedHandler(DependencyObject, RoutedEventHandler)
Adds a handler for the ToolTipOpened attached event
Declaration
public static void AddToolTipOpenedHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be added |
CloseBalloon()
Closes the current CustomBalloon, if the property is set.
Declaration
public void CloseBalloon()
Dispose()
Disposes the object.
Declaration
public void Dispose()
Remarks
This method is not virtual by design. Derived classes should override Simplic.Framework.Core.TaskbarNotification.TaskbarIcon.Dispose(System.Boolean).
Finalize()
This destructor will run only if the Dispose() method does not get called. This gives this base class the opportunity to finalize.
Important: Do not provide destructors in types derived from this class.
Declaration
protected void Finalize()
GetParentTaskbarIcon(DependencyObject)
Gets the ParentTaskbarIcon property. This dependency property indicates ....
Declaration
public static TaskbarIcon GetParentTaskbarIcon(DependencyObject d)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | d |
Returns
Type | Description |
---|---|
TaskbarIcon |
HideBalloonTip()
Hides a balloon ToolTip, if any is displayed.
Declaration
public void HideBalloonTip()
RaisePreviewTrayContextMenuOpenEvent()
A helper method to raise the PreviewTrayContextMenuOpen event.
Declaration
protected RoutedEventArgs RaisePreviewTrayContextMenuOpenEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaisePreviewTrayPopupOpenEvent()
A helper method to raise the PreviewTrayPopupOpen event.
Declaration
protected RoutedEventArgs RaisePreviewTrayPopupOpenEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaisePreviewTrayToolTipCloseEvent()
A helper method to raise the PreviewTrayToolTipClose event.
Declaration
protected RoutedEventArgs RaisePreviewTrayToolTipCloseEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaisePreviewTrayToolTipOpenEvent()
A helper method to raise the PreviewTrayToolTipOpen event.
Declaration
protected RoutedEventArgs RaisePreviewTrayToolTipOpenEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayBalloonTipClickedEvent()
A helper method to raise the TrayBalloonTipClicked event.
Declaration
protected RoutedEventArgs RaiseTrayBalloonTipClickedEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayBalloonTipClosedEvent()
A helper method to raise the TrayBalloonTipClosed event.
Declaration
protected RoutedEventArgs RaiseTrayBalloonTipClosedEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayBalloonTipShownEvent()
A helper method to raise the TrayBalloonTipShown event.
Declaration
protected RoutedEventArgs RaiseTrayBalloonTipShownEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayContextMenuOpenEvent()
A helper method to raise the TrayContextMenuOpen event.
Declaration
protected RoutedEventArgs RaiseTrayContextMenuOpenEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayLeftMouseDownEvent()
A helper method to raise the TrayLeftMouseDown event.
Declaration
protected RoutedEventArgs RaiseTrayLeftMouseDownEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayLeftMouseUpEvent()
A helper method to raise the TrayLeftMouseUp event.
Declaration
protected RoutedEventArgs RaiseTrayLeftMouseUpEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayMiddleMouseDownEvent()
A helper method to raise the TrayMiddleMouseDown event.
Declaration
protected RoutedEventArgs RaiseTrayMiddleMouseDownEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayMiddleMouseUpEvent()
A helper method to raise the TrayMiddleMouseUp event.
Declaration
protected RoutedEventArgs RaiseTrayMiddleMouseUpEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayMouseDoubleClickEvent()
A helper method to raise the TrayMouseDoubleClick event.
Declaration
protected RoutedEventArgs RaiseTrayMouseDoubleClickEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayMouseMoveEvent()
A helper method to raise the TrayMouseMove event.
Declaration
protected RoutedEventArgs RaiseTrayMouseMoveEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayPopupOpenEvent()
A helper method to raise the TrayPopupOpen event.
Declaration
protected RoutedEventArgs RaiseTrayPopupOpenEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayRightMouseDownEvent()
A helper method to raise the TrayRightMouseDown event.
Declaration
protected RoutedEventArgs RaiseTrayRightMouseDownEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayRightMouseUpEvent()
A helper method to raise the TrayRightMouseUp event.
Declaration
protected RoutedEventArgs RaiseTrayRightMouseUpEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayToolTipCloseEvent()
A helper method to raise the TrayToolTipClose event.
Declaration
protected RoutedEventArgs RaiseTrayToolTipCloseEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RaiseTrayToolTipOpenEvent()
A helper method to raise the TrayToolTipOpen event.
Declaration
protected RoutedEventArgs RaiseTrayToolTipOpenEvent()
Returns
Type | Description |
---|---|
System.Windows.RoutedEventArgs |
RemoveBalloonClosingHandler(DependencyObject, RoutedEventHandler)
Removes a handler for the BalloonClosing attached event
Declaration
public static void RemoveBalloonClosingHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be removed |
RemoveBalloonShowingHandler(DependencyObject, RoutedEventHandler)
Removes a handler for the BalloonShowing attached event
Declaration
public static void RemoveBalloonShowingHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be removed |
RemovePopupOpenedHandler(DependencyObject, RoutedEventHandler)
Removes a handler for the PopupOpened attached event
Declaration
public static void RemovePopupOpenedHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be removed |
RemoveToolTipCloseHandler(DependencyObject, RoutedEventHandler)
Removes a handler for the ToolTipClose attached event
Declaration
public static void RemoveToolTipCloseHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be removed |
RemoveToolTipOpenedHandler(DependencyObject, RoutedEventHandler)
Removes a handler for the ToolTipOpened attached event
Declaration
public static void RemoveToolTipOpenedHandler(DependencyObject element, RoutedEventHandler handler)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | element | UIElement or ContentElement that listens to the event |
System.Windows.RoutedEventHandler | handler | Event handler to be removed |
ResetBalloonCloseTimer()
Resets the closing timeout, which effectively keeps a displayed balloon message open until it is either closed programmatically through CloseBalloon() or due to a new message being displayed.
Declaration
public void ResetBalloonCloseTimer()
SetCustomBalloon(Popup)
Provides a secure method for setting the CustomBalloon property.
Declaration
protected void SetCustomBalloon(Popup value)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Controls.Primitives.Popup | value | The new value for the property. |
SetParentTaskbarIcon(DependencyObject, TaskbarIcon)
Sets the ParentTaskbarIcon property. This dependency property indicates ....
Declaration
public static void SetParentTaskbarIcon(DependencyObject d, TaskbarIcon value)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyObject | d | |
TaskbarIcon | value |
SetTrayPopupResolved(Popup)
Provides a secure method for setting the TrayPopupResolved property.
This dependency property indicates ....
Declaration
protected void SetTrayPopupResolved(Popup value)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Controls.Primitives.Popup | value | The new value for the property. |
SetTrayToolTipResolved(ToolTip)
Provides a secure method for setting the TrayToolTipResolved property.
Declaration
protected void SetTrayToolTipResolved(ToolTip value)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Controls.ToolTip | value | The new value for the property. |
ShowBalloonTip(String, String, BalloonIcon)
Displays a balloon tip with the specified title, text, and icon in the taskbar for the specified time period.
Declaration
public void ShowBalloonTip(string title, string message, BalloonIcon symbol)
Parameters
Type | Name | Description |
---|---|---|
System.String | title | The title to display on the balloon tip. |
System.String | message | The text to display on the balloon tip. |
BalloonIcon | symbol | A symbol that indicates the severity. |
ShowBalloonTip(String, String, Icon)
Displays a balloon tip with the specified title, text, and a custom icon in the taskbar for the specified time period.
Declaration
public void ShowBalloonTip(string title, string message, Icon customIcon)
Parameters
Type | Name | Description |
---|---|---|
System.String | title | The title to display on the balloon tip. |
System.String | message | The text to display on the balloon tip. |
System.Drawing.Icon | customIcon | A custom icon. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | If |
ShowCustomBalloon(UIElement, PopupAnimation, Nullable<Int32>)
Shows a custom control as a tooltip in the tray location.
Declaration
public void ShowCustomBalloon(UIElement balloon, PopupAnimation animation, int? timeout)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.UIElement | balloon | |
System.Windows.Controls.Primitives.PopupAnimation | animation | An optional animation for the popup. |
System.Nullable<System.Int32> | timeout | The time after which the popup is being closed. Submit null in order to keep the balloon open inde |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | If |
Events
| Improve this Doc View SourcePreviewTrayContextMenuOpen
Tunneled event that occurs when the context menu of the taskbar icon is being displayed.
Declaration
public event RoutedEventHandler PreviewTrayContextMenuOpen
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
PreviewTrayPopupOpen
Tunneled event that occurs when the custom popup is being opened.
Declaration
public event RoutedEventHandler PreviewTrayPopupOpen
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
PreviewTrayToolTipClose
Tunneled event that occurs when a custom tooltip is being closed.
Declaration
public event RoutedEventHandler PreviewTrayToolTipClose
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
PreviewTrayToolTipOpen
Tunneled event that occurs when the custom ToolTip is being displayed.
Declaration
public event RoutedEventHandler PreviewTrayToolTipOpen
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayBalloonTipClicked
Occurs when the user clicks on a balloon ToolTip.
Declaration
public event RoutedEventHandler TrayBalloonTipClicked
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayBalloonTipClosed
Occurs when a balloon ToolTip was closed.
Declaration
public event RoutedEventHandler TrayBalloonTipClosed
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayBalloonTipShown
Occurs when a balloon ToolTip is displayed.
Declaration
public event RoutedEventHandler TrayBalloonTipShown
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayContextMenuOpen
Bubbled event that occurs when the context menu of the taskbar icon is being displayed.
Declaration
public event RoutedEventHandler TrayContextMenuOpen
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayLeftMouseDown
Occurs when the user presses the left mouse button.
Declaration
public event RoutedEventHandler TrayLeftMouseDown
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayLeftMouseUp
Occurs when the user releases the left mouse button.
Declaration
public event RoutedEventHandler TrayLeftMouseUp
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayMiddleMouseDown
Occurs when the user presses the middle mouse button.
Declaration
public event RoutedEventHandler TrayMiddleMouseDown
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayMiddleMouseUp
Occurs when the user releases the middle mouse button.
Declaration
public event RoutedEventHandler TrayMiddleMouseUp
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayMouseDoubleClick
Occurs when the user double-clicks the taskbar icon.
Declaration
public event RoutedEventHandler TrayMouseDoubleClick
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayMouseMove
Occurs when the user moves the mouse over the taskbar icon.
Declaration
public event RoutedEventHandler TrayMouseMove
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayPopupOpen
Bubbled event that occurs when the custom popup is being opened.
Declaration
public event RoutedEventHandler TrayPopupOpen
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayRightMouseDown
Occurs when the presses the right mouse button.
Declaration
public event RoutedEventHandler TrayRightMouseDown
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayRightMouseUp
Occurs when the user releases the right mouse button.
Declaration
public event RoutedEventHandler TrayRightMouseUp
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayToolTipClose
Bubbled event that occurs when a custom tooltip is being closed.
Declaration
public event RoutedEventHandler TrayToolTipClose
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |
TrayToolTipOpen
Bubbled event that occurs when the custom ToolTip is being displayed.
Declaration
public event RoutedEventHandler TrayToolTipOpen
Event Type
Type | Description |
---|---|
System.Windows.RoutedEventHandler |