WPF NotifyIcon

April 2nd, 2016

 

Version 1.0.8 released April 2nd 2016.

This is an implementation of a NotifyIcon (aka system tray icon or taskbar icon) for the WPF platform. It does not just rely on the Windows Forms NotifyIcon component, but is a purely independent control which leverages several features of the WPF framework in order to display rich ToolTips, Popups, context menus, and balloon messages. It can be used directly in code or embedded in any XAML file.

image

Browse/fork/clone Git repository (includes sample application)
Download library via NuGet

 

 

Features at a glance

  • Custom Popups (interactive controls) on mouse clicks.
  • Customized ToolTips (Vista and above) with fallback mechanism for xp/2003.
  • Rich event model including attached events to trigger animations in Popups, ToolTips, and balloon messages. I just love that.
  • Full support for standard Windows balloons, including custom icons.
  • Custom balloons that pop up in the tray area. Go wild with styles and animations 🙂
  • Support for WPF context menus.
  • You can define whether to show Popups on left-, right-, double-clicks etc. The same goes for context menus.
  • Simple data binding for Popups, ToolTips and custom balloons through attached properties and derived data context.
  • Command support for single / double clicks on the tray icon.

Tutorial and Support

        A comprehensive tutorial that complements the attached sample application can be found on the Code Project:

http://www.codeproject.com/KB/WPF/wpf_notifyicon.aspx

Please post support questions to the CodeProject forum only. Thank you.

Screenshots

The screenshots below were taken from NetDrives and the sample application.

quickaccess

 

image

 

image

 

image

 

image

 

XAML Declaration Sample

The sample below shows some of the properties of the control. For a more comprehensive sample, have a look at the sample application that comes with the download.

<Window
  x:Class="Hardcodet.NetDrives.UI.SystemTray.Sample"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  xmlns:tb="http://www.hardcodet.net/taskbar">

    <tb:TaskbarIcon x:Name="myNotifyIcon"
                    Visibility="Visible"
                    ToolTipText="Fallback ToolTip for Windows xp"
                    IconSource="/Images/TrayIcons/Logo.ico"
                    ContextMenu="{StaticResource TrayMenu}"
                    MenuActivation="LeftOrRightClick"
                    TrayPopup="{StaticResoure TrayStatusPopup}"
                    PopupActivation="DoubleClick"
                    TrayToolTip="{StaticResource TrayToolTip}"
      />

</Window>
  1. November 25th, 2010 at 11:04 | #1

    @Morey and Daub:
    The URI is just the namespace identifier – there’s nothing to download there. If the type cannot be resolved, you probably have a missing reference. Please compare with the sample project in order to determine what’s missing.

  2. Robbert Dam
    November 30th, 2010 at 06:01 | #2

    Thanks for this great lib! I’ve used the control for quite a while now. A question: I wonder if it’s possible to control the Z-order of the popup. The popup in my application sometimes “conflicts” with a popup of another application. I want to render my popup “always-on-top”. Is there an easy way to do this?

  3. Chris Baker
    January 5th, 2011 at 16:03 | #3

    I was in the process of writing my own version of a wpfnotifier as there isn’t a native one in the WPF library. Thankfully I came across your code before I got too far with it as yours is excellent. So thanks for sharing it.

    I do have a question though. It works fine on my Win 7 (64bit) machine, but when I try and use it a Vista machine I have trouble getting it to close. I call the dispose method and then close the app and it remains in memory running until I either stop debugging or use process manager to kill it manually. This is the same code on Win 7 but it closes normally. To reproduce the problem the notifyicon must either open a window or display a pop up of some kind (such as a tooltip) then it won’t close otherwise it does ?!?!? Have you come across this issue? I’m still working toward a solution and if I find one I’ll let you know, but if you’ve already isolated the issue, if you could let me know that would be great.

    Thanks for the great work.

    Chris. B.

  4. Robert
    January 25th, 2011 at 11:56 | #4

    Great Work!
    Thank you very muck!

    I added a textbox inside a popup and when you type nothing happens…
    I don’t know what is the problem.

  5. January 29th, 2011 at 05:11 | #5

    Robert,
    Are you working with the latest version? There was such an issue with an early version of the control…

  6. James
    February 3rd, 2011 at 09:08 | #6

    Philipp – Nice work. Quick question. Is there an easy way to just use this as a nice tooltip replacement to get balloon tips on any WPF object? (Paths in my case and I need to do in in the code behind)

    I am creating ToolTips programmatically and then calling ToolTipService.SetShowOnDisabled to assign them to my Paths. It would be nice to do something similar with your Balloon popup! Any way to do so?

  7. February 4th, 2011 at 04:23 | #7

    James,

    The balloons are also just standard popups – you can display them for any control by just setting the PlacementTarget – just check their usage in the control, which is pretty trivial.

    Cheers,
    Philipp

  8. Mark
    February 25th, 2011 at 06:19 | #8

    Hi,
    Great control, thanks for your efforts.
    I made a small modification. I found the positioning of context menu and custom popup a little odd. I am surprised nobody else has seen this. Maybe its because I use two screens. However, changing the placement to PlacementMode.MousePoint mad it work much better:

    /*
    //use absolute position
    ContextMenu.Placement = PlacementMode.AbsolutePoint;
    ContextMenu.HorizontalOffset = cursorPosition.X;
    ContextMenu.VerticalOffset = cursorPosition.Y;
    */
    // FIX: use mousepoint as the positioning - works better
    ContextMenu.Placement = PlacementMode.MousePoint;

  9. anonymous
    March 6th, 2011 at 22:38 | #9

    Vista built-in system tray icons like Power, Date/Time, Volume, Network had rich tooltips with icons but Windows 7 has plain tooltips for system tray icons. Can you bring rich tooltips for system icons on Windows 7?

  10. Keith
    March 29th, 2011 at 03:32 | #10

    @Christian
    Hi Christian, when compiling for c# 4.0 you can fix the “No constructor for type ‘HideSampleWindowsCommand’ has 0 parameters.” warnings by adding default constructors to the ShowSampleWindowCommand and HideSampleWindowsCommand classes (e.g. “public HideSampleWindowCommand() : base(){}”). However there is at least one other problem with the C# 4.0 version, you can see it by starting the same project, “Open sample Window” then right click the tray icon for the context menu – Options “Show/Hide Context Menu” are permanently greyed out, and the tooltips text is no longer visible (tested under Win XP VS2010 C# V4.0). Still trying to work out why, any tips appreciated, thanks.

  11. March 31st, 2011 at 01:04 | #11

    Keith and others

    I’ll look at theses issues with C# 4.0 asap and post back.

    Cheers,
    Philipp

  12. Alexander Voronin
    April 7th, 2011 at 05:38 | #12

    Hi. I found this topic on CodeProject but since yesterday did not get any suggestions on trigger error. It seems that I misunderstood something in WPF/XAML but I can’t get to work this simply case. I’d like to run trigger by checking context menu attached to notify icon. Sample code yo may find at Your article discussion at CodeProject here – http://www.codeproject.com/Messages/3848077/Re-How-about-triggers-in-ContextMenu.aspx

    I would appreciate any comments and suggestions. And thanx for great work!

  13. macias
    April 26th, 2011 at 00:17 | #13

    Many, many thanks for your library! It helped me a lot. I have one question — you can set animation for you custom balloon, for example as slide. Is there any way to set animation for “closing” the balloon — I would like to slide it down (exactly speaking: to slide it down on timeout, to close it on user manual close). Thank you in advance for figuring it out.

  14. Alexander Voronin
    April 27th, 2011 at 10:14 | #14

    Still no suggestions?

  15. May 10th, 2011 at 02:25 | #15

    Hi

    Very cool library. We use it in Nemo Documents and so far it’s really great. There is just one little problem that we get once in a while, the “Could not create icon data” exception.

    As can be seen here:

    http://msdn.microsoft.com/en-us/library/bb762159%28v=vs.85%29.aspx

    It appears to be related to startup. But I have tried doing a the try and sleep and bit before trying again for a couple of times. This took away quite a bit of them, but there are still some left.

    Looking comments in that microsoft article, maybe it would be a good idea to hook into the WM_CREATE event? That way it would also work if explorer crashed and is restarted.

  16. Ryan
    May 26th, 2011 at 05:33 | #16

    I tried setting the icon for TaskBarIcon

    Sample Code :

    but it gives me this error, I think I already set the icon correctly but still error occurs
    Error : Provide value on ‘System.Windows.Baml2006.TypeConverterMarkupExtension

    Any ideas?

  17. Wietse Sas
    July 13th, 2011 at 03:13 | #17

    Hi,

    I was trying to use the notifyicon for a project i’m working on.

    I came across a bug, to reproduce:
    – End process “explorer.exe”.
    – Start your program which uses the notifyicon (or start your project in visual studio).
    – Start process “explorer.exe”.

    This problem also occurres when a user with a large roaming profile logs on and the program with the notifyicon starts when windows starts. At this time, explorer is not fully started until the user’s profile is loaded.

  18. Phil Jagger
    July 13th, 2011 at 11:34 | #18

    @Chris Baker

    Make sure you’ve set your Application’s ShutdownMode to OnMainWindowClose. By default it’s set to LastWindowClosed and since the notify icon creates a window, it will keep your application alive after the main window closes and you’ll have to kill it from the task manager.

  19. Marcos Lommez
    August 2nd, 2011 at 11:05 | #19

    Hi Philipp,

    I’ve downloaded your WPF NotifyIcon and is great control.
    I’m a new WPF coder, learning the MVVM pattern.
    In my application i’m trying to bind a context menu to a command that i’ve created.
    In a resource file, i’ve created the taskBarIcon and the context menu.

    Here is how, i’m creating the TaskBarIcon and the context menu:

    Here is my base class for commands:

    public class ViewModelCommand : ICommand
    {
    public ViewModelCommand(Action executeAction,
    Predicate canExecute)
    {
    if (executeAction == null)
    throw new ArgumentNullException(“executeAction”);

    _executeAction = executeAction;
    _canExecute = canExecute;
    }

    private readonly Predicate _canExecute;
    public bool CanExecute(object parameter)
    {
    if (_canExecute == null) return true;

    return _canExecute(parameter);
    }

    public event EventHandler CanExecuteChanged;
    public void OnCanExecuteChanged()
    {
    if (CanExecuteChanged != null)
    CanExecuteChanged(this, EventArgs.Empty);
    }

    private readonly Action _executeAction;
    public void Execute(object parameter)
    {
    _executeAction(parameter);
    }
    }

    Here is the viewmodel code for my main window

    public class MainViewModel : ViewModel
    {
    public DataClient dataClient;
    public TaskbarIcon taskBarIcon;

    private ViewModelCommand fCheckSomethingOnServer = null;
    public ViewModelCommand CheckSomethingOnServer
    {
    get
    {
    if (fCheckSomethingOnServer == null)
    {
    fCheckSomethingOnServer = new ViewModelCommand(p => CheckSomething(this, new CheckSomethingEventArgs(dataClient)), p => CanCheckSomething);
    }

    return fCheckSomethingOnServer;
    }
    }

    public class CheckSomethingEventArgs : EventArgs
    {
    public CheckSomethingEventArgs(DataClient dataClient)
    {
    this.dataClient = dataClient;
    }
    public DataClient dataClient { get; set; }
    }

    private void CheckSomething(object sender, CheckSomethingEventArgs e)
    {
    e.DataClient.CheckSomething();
    }

    private bool CanCheckSomething
    {
    get { return dataClient.Logged; }
    }
    }

    Here is the Main Window code:

    public DataClient dataClient;
    private TaskbarIcon tb;
    private MainViewModel _viewModel = null;

    public MainWindow()
    {
    InitializeComponent();
    dataClient = new DataClient();
    tb = (TaskbarIcon)FindResource(“MyNotifyIcon”);
    if (fViewModel == null)
    {
    fViewModel = new MainViewModel();
    fViewModel.dataClient = dataClient;
    fViewModel.taskBarIcon = tb;
    DataContext = fViewModel;
    }
    }

    The problem is that the CheckSomethingOnServer command is never fired.
    Could you help me to fix that problem?
    Feel free to contact my by e-mail.

    Thanks

    Best regards,
    Marcos Lommez

  20. Frank
    August 18th, 2011 at 05:40 | #20

    Wow, I was amazed to the extend of work you put in this assembly. Thank you very much for your efforts. So far, it works fantastic. Big thanks.

  21. August 19th, 2011 at 10:24 | #21

    loving this thing man! THanks! BUilding a timer tool that helps me track multitasking and also add notes to keep track of where i am with all. Lemme know if you’re interested i’ll send it to you – Rich

  22. Marcos Lommez
    August 23rd, 2011 at 02:52 | #22

    Anyone could help me to fix that problem in my previous post?
    Thanks

  23. August 26th, 2011 at 02:45 | #23

    Hi,
    thank you for this awesome tuto and component !
    I tried to add a webbrowser wpf component to the notification but it stays invisible (works when I click on it).
    Do you have any idea to solve this ?
    Regards

  24. August 26th, 2011 at 03:16 | #24

    @Oz

    I found why, this is cause by the AllowsTransparency attributes :
    http://blogs.msdn.com/b/changov/archive/2009/01/19/webbrowser-control-on-transparent-wpf-window.aspx

    Thanks

  25. Keith
    September 14th, 2011 at 00:25 | #25

    @Anders Rune Jensen
    We also see the “Could not create icon data” exception infrequently on app startup. Still looking for a permanent fix…

  26. September 20th, 2011 at 03:33 | #26

    Hey,

    Excellent work here!

    I’m trying to display the context menu on a left click, but can’t get it to work. It’s easy to capture the left click event, but there doesn’t seem to be a way to force the context menu to show?

    Thanks!

  27. Michael Hedgpeth
    September 24th, 2011 at 09:27 | #27

    @Anders Rune Jensen I am experiencing the same intermittent issue on startup. Did you ever do anything to fix this? If so, would you be willing to share the changes you made?

    BTW, interesting product; I’m going to have to check it out!

  28. slhenty
    October 5th, 2011 at 08:59 | #28

    First, thanks for a terrific library!

    We’ve run into an issue we don’t know how to solve. We’re getting a couple empty spaces in the systray along with the NotifyIcon. Each of the extras takes up the same space as a normal systray icon, but with no icon, no tooltip, etc., just the normal OS hover state.

    Anyone seen this, or know how to resolve?

    Best!

  29. October 9th, 2011 at 10:36 | #29

    @Wietse Sas

    Did you manage to come up with a solution for this?

  30. John Smith
    November 19th, 2011 at 19:26 | #30

    The included sample works nicely. However, whenever I change the project from .NET 3.5 to .NET 4.0 Client Profile, it all breaks. Menu items become disabled or disappear, and most importantly (to me), the context menus appear higher up (past the taskbar) instead of where the mouse is over the icon. I am having these issues in my own .NET 4.0 Client Profile project when using your WPF NotifyIcon. I just want the menu to appear in the right place. Do you have a solution for this?

  31. Michael
    November 21st, 2011 at 12:50 | #31

    Hi,
    Thanks for such a great control! However, could you please consider re-licensing it under a more mainstream license? The CPOL license has a few quite bizarre clausules, which results in it being GPL-incompatible. For example the Apache license is quite similar to the CPOL but is GPL compatible.

    Thanks!

  32. Shane
    November 30th, 2011 at 18:26 | #32

    First off cool control.

    If I create a helper class like

    public static void DisplayMessageArea(string messageToDisplay)
    {

    TaskbarIcon task =new TaskbarIcon();
    task.ToolTipText = messageToDisplay;

    The tooltip is displayed however it never goes away. If I call the helper class again and again. The amount of tooltips keeps growing and growing.

    I have tried Dispose & Close however it doesnt help.

    Have you had this problem before?

  33. Vladimir
    December 25th, 2011 at 07:38 | #33

    Can’t install it using nuget for .net 3.5

    Successfully installed ‘Hardcodet.Wpf.TaskbarNotification 1.0.4.0’.
    Successfully uninstalled ‘Hardcodet.Wpf.TaskbarNotification 1.0.4.0’.
    Install failed. Rolling back…
    Could not install package ‘Hardcodet.Wpf.TaskbarNotification 1.0.4.0’. You are trying to install this package into a project that targets ‘.NETFramework,Version=v3.5’, but the package does not contain any assembly references that are compatible with that framework. For more information, contact the package author.

  34. Jon
    February 7th, 2012 at 23:31 | #34

    Hi,
    Love the project. Just one question though, on the balloon tip demo, there seems to be a blank icon in the system tray alongside the other icon. In my own project, I’m using your example code, but I’m having the same problem whereby a blank icon shows next to the notify icon. Do you know why this might be happening?
    Thanks,
    Jon

  35. Sys
    March 7th, 2012 at 08:41 | #35

    Hi Sumi

    Thank you for this great library. I just have one problem when my program closed, the icon is still in the tray bar. Only when my mouse is over it, then it vanishes. Here’s my code:

    protected override void OnStateChanged(EventArgs e)
    {
    if (WindowState == WindowState.Minimized)
    {
    this.Hide();
    tiNotify.Visibility = System.Windows.Visibility.Visible;
    }
    else tiNotify.Visibility = System.Windows.Visibility.Collapsed;

    base.OnStateChanged(e);
    }

    protected override void OnClosing(System.ComponentModel.CancelEventArgs e)
    {
    //clean up notifyicon (would otherwise stay open until application finishes)
    tiNotify.Dispose();
    base.OnClosing(e);
    }

  36. Ondrej Dobias
    March 18th, 2012 at 02:46 | #36

    Thanks for the great icon component!

    One suggestion to make it immediately usable for localization needs: mark the NotifyIconData structure and Shell_NotifyIcon with CharSet = CharSet.Unicode.

    In my case some (Czech) characters were converted incorrectly without doing so.

  37. Rex
    May 11th, 2012 at 21:31 | #37

    I haven’t see any reaponse to the issue with using C# version 4.0 (context menu not enabled). Is there an update available somewhere?

    Thanks

  38. sunny06
    May 14th, 2012 at 09:35 | #38

    Hello,
    Did you guys tried to use this brilliant tool and to set the ShowInTaskbar to False?
    I’ve a big issue when users click on “show desktop” and click on the notifyicon, I can’t get the window on the top.
    Thanks if you have any tip.

  39. Jose
    May 17th, 2012 at 22:25 | #39

    Thank you for developing and sharing this piece of code.

  40. Mike Eshva
    May 18th, 2012 at 09:27 | #40

    I’ve found a strange bag. If on the PC installed Wacom tablet driver (may be any stylus input device driver, I have a Wacom device) and application uses your component, it cannot correctly shut down. The application just isn’t removed from memory. Disposing TaskbarIcon doesn’t help. .NET Framework 4.0
    Workaround is disabling whole support for tablet devices in the application as it is described in http://msdn.microsoft.com/en-us/library/dd901337(VS.90).aspx
    Like this:
    private static void DisableTabletSupport()
    {
    // Get a collection of the tablet devices for this window.
    TabletDeviceCollection lDevices = Tablet.TabletDevices;

    if (lDevices.Count > 0)
    {
    // Get the Type of InputManager.
    Type lInputManagerType = typeof (InputManager);

    // Call the StylusLogic method on the InputManager.Current instance.
    object lStylusLogic = lInputManagerType.InvokeMember(
    “StylusLogic”,
    BindingFlags.GetProperty | BindingFlags.Instance | BindingFlags.NonPublic,
    null,
    InputManager.Current,
    null);

    if (lStylusLogic != null)
    {
    // Get the type of the stylusLogic returned from the call to StylusLogic.
    Type lStylusLogicType = lStylusLogic.GetType();

    // Loop until there are no more devices to remove.
    while (lDevices.Count > 0)
    {
    // Remove the first tablet device in the devices collection.
    lStylusLogicType.InvokeMember(
    “OnTabletRemoved”,
    BindingFlags.InvokeMethod | BindingFlags.Instance |
    BindingFlags.NonPublic,
    null,
    lStylusLogic,
    new object[] {(uint) 0});
    }
    }
    }
    }

  41. weaver
    May 28th, 2012 at 07:59 | #41

    Philipp, I’ve used this code successfully in a “native” WPF project and have found it reliable and easy to work with. Thanks for sharing.

    I would now like to use it in an ExcelDNA addin project which allows visualisation of objects which Excel is unable to display. However, in this situation there is no Application object. I note that you check for Application.Current != null in the TaskBarIcon ctor, but elsewhere this check is not performed and consequently exceptions are thrown (for example, clicking the icon). Fixing this should be relatively trivial.

    I also observed an issue with focus and context menus. The WPF context menu displays correctly on right-click, but disappears when the mouse enters the menu region (or Excel). I’m not sure how to go about fixing this.

    NB I have no problems if I use the WinForms NotifyIcon.

  42. weaver
    May 28th, 2012 at 08:49 | #42

    Apologies Philipp, I see above that you request comments be posted to codeproject only, but for those who stumble upon my comment, I fixed the focus issue using the solution suggested at the following link (with some minor alterations):

    http://blogs.msdn.com/b/vsod/archive/2009/12/16/excel-2007-wpf-events-are-not-fired-for-items-that-overlap-excel-ui-for-wpf-context-menus.aspx

    Regards

  43. Peter Klavins
    June 6th, 2012 at 07:52 | #43

    I’ve been trying this with Windows 8 (it’s embedded inside the project https://github.com/play/play-windows), and it seems that CreateMessageWindows() is failing with a memory access violation caused on a call to WinApi.CreateWindow. Is it possible that the Hardcodet.Wpf.TaskbarNotification.Interop class has to be changed because of some underlying changes in Windows 8 with respect to previous Windows versions? Does anyone know any more about this?

  44. June 7th, 2012 at 19:45 | #44

    Hi,

    Here are portions of my code:

    using TBN = Hardcodet.Wpf.TaskbarNotification;

    and

    TBN.TaskbarIcon tbi = new TBN.TaskbarIcon();
    tbi.ShowBalloonTip(“Welcome”, “This is a test”, TBN.BalloonIcon.Info);

    After awhile the balloontip goes away from the system tray, but it leaves behind an empty space there.
    How can I remove that empty space when the balloontip is no longer visible?

    Thanks,
    Claire

  45. Dave
    June 21st, 2012 at 07:50 | #45

    I was wondering why there was a pause before my popup was shown. I found it was because of the mouse event handling so I changed it as follows. This then defaults to show immediately. Basically if double clicking hasn’t been setup then we don’t need to check for it. The same applies to the menu activation.

    //show popup, if requested
    if (me.IsMatch(PopupActivation))
    {
    if (me == MouseEvent.IconLeftMouseUp)
    {
    if (PopupActivation == PopupActivationMode.DoubleClick
    || PopupActivation == PopupActivationMode.LeftOrDoubleClick
    || PopupActivation == PopupActivationMode.All)

Comment pages
1 2 3 4 5 7 452
  1. February 26th, 2011 at 20:07 | #1
  2. September 27th, 2011 at 07:25 | #2
  3. September 27th, 2011 at 07:29 | #3
  4. February 2nd, 2012 at 04:03 | #4
  5. April 28th, 2012 at 14:37 | #5