H.NotifyIcon.Wpf 2.0.74

There is a newer version of this package available.
See the version list below for details.
dotnet add package H.NotifyIcon.Wpf --version 2.0.74
NuGet\Install-Package H.NotifyIcon.Wpf -Version 2.0.74
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="H.NotifyIcon.Wpf" Version="2.0.74" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add H.NotifyIcon.Wpf --version 2.0.74
#r "nuget: H.NotifyIcon.Wpf, 2.0.74"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install H.NotifyIcon.Wpf as a Cake Addin
#addin nuget:?package=H.NotifyIcon.Wpf&version=2.0.74

// Install H.NotifyIcon.Wpf as a Cake Tool
#tool nuget:?package=H.NotifyIcon.Wpf&version=2.0.74

H.NotifyIcon

** This project is a continuation of the inactive base project to other platforms (WinUI/Uno.Skia.Wpf/Console) - ❤️ https://github.com/hardcodet/wpf-notifyicon ❤️ **

This is an implementation of a NotifyIcon (aka system tray icon or taskbar icon) for .Net 6 WPF/WinUI/Uno.Skia.WPF/Console platforms. It does not just rely on the Windows Forms NotifyIcon component, but is a purely independent control which leverages several features of the WPF/WinUI frameworks 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.

Features

NuGet

NuGet NuGet NuGet NuGet

Install-Package H.NotifyIcon.Wpf
Install-Package H.NotifyIcon.WinUI
Install-Package H.NotifyIcon.Uno
Install-Package H.NotifyIcon.Uno.WinUI
# If you need other platforms, you can use this Core library - 
# it allows you to make NotifyIcon even in a console application.
Install-Package H.NotifyIcon

Usage

<Window
    xmlns:tb="clr-namespace:H.NotifyIcon;assembly=H.NotifyIcon.Wpf" // WPF
    xmlns:tb="using:H.NotifyIcon" // WinUI
    >
    <tb:TaskbarIcon
        ToolTipText="ToolTip"
        IconSource="/Images/TrayIcons/Logo.ico"
        ContextMenu="{StaticResource TrayMenu}"
        MenuActivation="LeftOrRightClick"
        TrayPopup="{StaticResource TrayStatusPopup}"
        PopupActivation="DoubleClick"
        TrayToolTip="{StaticResource TrayToolTip}"
        />
</Window>

Efficiency Mode image

Windows 11 introduces a new concept called Efficiency Mode.
Since, basically, this library is intended for applications to exist in the background with the ability to interact through TrayIcon, the library implements an API for this mode:

EfficiencyModeUtilities.SetEfficiencyMode(bool value)
WindowExtensions.Hide(this Window window, enableEfficiencyMode: true) // default value
WindowExtensions.Show(this Window window, disableEfficiencyMode: true) // default value
TaskbarIcon.ForceCreate(bool enablesEfficiencyMode = true) // default value

Generated icons

Example 1: <img width="15" alt="image" src="https://user-images.githubusercontent.com/3002068/163721411-1388f2b4-a039-4b4a-8114-f74bfc8835ba.png">

<tb:TaskbarIcon>
    <tb:TaskbarIcon.GeneratedIcon>
        <tb:GeneratedIcon
            Text="❤️"
            Foreground="Red"
            />
    </tb:TaskbarIcon.GeneratedIcon>
</tb:TaskbarIcon>

Example 2: <img width="14" alt="image" src="https://user-images.githubusercontent.com/3002068/163721399-cbfd0286-d2d4-4b40-b3f3-388c9613f535.png">

<tb:TaskbarIcon
    IconSource="/Icons/Error.ico"
    >
    <tb:TaskbarIcon.GeneratedIcon>
        <tb:GeneratedIcon
            Text="5"
            Foreground="Black"
            FontSize="36"
            FontWeight="Bold"
            />
    </tb:TaskbarIcon.GeneratedIcon>
</tb:TaskbarIcon>

Example 3: <img width="19" alt="image" src="https://user-images.githubusercontent.com/3002068/163721367-dc6878df-3ec2-4288-b699-cf664894e1b1.png">

<tb:TaskbarIcon>
    <tb:TaskbarIcon.GeneratedIcon>
        <tb:GeneratedIcon
            Text="❤️"
            Foreground="Red"
            FontFamily="Segoe UI Emoji"
            Background="AliceBlue"
            FontWeight="Bold"
            FontSize="38"
            />
    </tb:TaskbarIcon.GeneratedIcon>
</tb:TaskbarIcon>

Example 4: <img width="18" alt="image" src="https://user-images.githubusercontent.com/3002068/163723782-8b135584-8b35-401e-926e-0fe0e7aa801e.png">

<tb:TaskbarIcon>
    <tb:TaskbarIcon.GeneratedIcon>
        <tb:GeneratedIcon
            Text="❤️"
            BorderThickness="5"
            FontSize="46"
            >
            <tb:GeneratedIcon.Foreground>
                <LinearGradientBrush StartPoint="0,0" EndPoint="128,128">
                    <GradientStop Color="White" />
                    <GradientStop Color="Red" />
                </LinearGradientBrush>
            </tb:GeneratedIcon.Foreground>
            <tb:GeneratedIcon.BorderBrush>
                <LinearGradientBrush StartPoint="0,0" EndPoint="128,128">
                    <GradientStop Color="White" />
                    <GradientStop Color="Red" />
                </LinearGradientBrush>
            </tb:GeneratedIcon.BorderBrush>
        </tb:GeneratedIcon>
    </tb:TaskbarIcon.GeneratedIcon>
</tb:TaskbarIcon>

Design-Time Access

It is recommended to pin the designer icon for easy viewing. To do this, go to Taskbar Settings → Other system tray icons and enable this icon:
<img width="412" alt="image" src="https://user-images.githubusercontent.com/3002068/163700588-eb2ad5f2-45d0-4b6f-ad39-c66f96202cb5.png">

WinUI Context menu

At the moment, three modes are implemented, each with its own pros and cons.

  1. Based on your MenuFlyout, a Win32 PopupMenu will be created that will call the commands attached to your MenuFlyoutItem. This is the default. <img width="174" alt="image" src="https://user-images.githubusercontent.com/3002068/164977047-e8497047-0c6d-4f99-b160-bc1c1a1a6c3f.png">
  2. The menu will be created in your open window, in the corner of the screen.
  3. A second transparent window will be created and used to render the native menu.. At the moment it is in the preview stage. To do this you need to explicitly set ContextMenuMode="SecondWindow"
    image

Availability of various options(depends on the version of WindowsAppSDK you are using): Option | Packaged App | Unpackaged App -------------|------------------------------|----------------------------------- Transparency | 🟢 from 1.1.0-preview | 🟢 from 1.1.0-preview Borderless | 🔷 | 🟢 from 1.1.0-preview Animations | 🟢, but with borders | 🟢 from 1.1.0-preview Submenus | 🔷 | 🔷

Behavior that needs attention

  1. This implementation currently uses the Guid associated with each TrayIcon. The default is a hash function that creates a unique Guid based on the path to your file, because Windows associates the guid with the current path when TrayIcon is registered. The only way to keep the settings when changing the file path is to use Authenticode. Read more here: https://docs.microsoft.com/en-us/windows/win32/api/shellapi/ns-shellapi-notifyicondataa#troubleshooting

Sample Apps

The minimum supported version of the .Net Framework is 4.5.1.
So in some cases to build the project you will need to install this -
https://dotnet.microsoft.com/en-us/download/dotnet-framework/thank-you/net451-developer-pack-offline-installer

Support

Priority place for bugs: https://github.com/HavenDV/H.NotifyIcon/issues
Priority place for ideas and general questions: https://github.com/HavenDV/H.NotifyIcon/discussions
I also have a Discord support channel:
https://discord.gg/g8u2t9dKgE

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net6.0-windows7.0 is compatible.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
.NET Framework net451 is compatible.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on H.NotifyIcon.Wpf:

Package Downloads
ChrisKaczor.Wpf.Windows.FloatingStatusWindow

Library to create a "floating" window that blends in with the Windows desktop and allows displaying status text.

GitHub repositories (4)

Showing the top 4 popular GitHub repositories that depend on H.NotifyIcon.Wpf:

Repository Stars
2dust/v2rayN
A GUI client for Windows, support Xray core and v2fly core and others
nguyenquyhy/Flight-Tracker-StreamDeck
A Stream Deck plugin to interact with Microsoft Flight Simulation
iXab3r/MicSwitch
MicSwitch is a tool which allows you to mute/unmute your microphone using a predefined hotkey
ResetXPDR/MSFS2020_AutoFPS
A simple utility for MSFS to automatically adjust key settings to improve performance and smoothness.
Version Downloads Last updated
2.0.131 1,976 5/1/2024
2.0.129 251 4/26/2024
2.0.128 154 4/25/2024
2.0.124 7,069 1/3/2024
2.0.123 2,753 12/2/2023
2.0.122 147 11/30/2023
2.0.118 6,841 9/20/2023
2.0.117 613 9/13/2023
2.0.116 365 9/7/2023
2.0.115 3,419 8/2/2023
2.0.114 264 8/1/2023
2.0.113 147 8/1/2023
2.0.112 883 7/26/2023
2.0.111 191 7/26/2023
2.0.110 144 7/26/2023
2.0.108 9,120 4/5/2023
2.0.106 214 4/5/2023
2.0.105 308 4/1/2023
2.0.104 1,847 3/28/2023
2.0.103 221 3/28/2023
2.0.99 1,020 3/13/2023
2.0.98 229 3/13/2023
2.0.97 233 3/13/2023
2.0.95 336 3/12/2023
2.0.94 816 3/9/2023
2.0.93 411 3/5/2023
2.0.86 2,517 2/3/2023
2.0.84 280 2/2/2023
2.0.77 2,074 1/12/2023
2.0.76 334 1/10/2023
2.0.75 371 1/5/2023
2.0.74 7,550 11/8/2022
2.0.73 985 10/13/2022
2.0.72 411 10/13/2022
2.0.68 787 10/4/2022
2.0.67 547 9/22/2022
2.0.66 936 9/16/2022
2.0.64 904 8/23/2022
2.0.63 493 8/17/2022
2.0.60 632 8/10/2022
2.0.59 1,104 8/1/2022
2.0.58 691 7/26/2022
2.0.57 487 7/21/2022
2.0.56 574 7/17/2022
2.0.55 450 7/15/2022
2.0.54 434 7/15/2022
2.0.53 903 6/24/2022
2.0.52 448 6/24/2022
2.0.51 456 6/23/2022
2.0.50 875 5/24/2022
2.0.49 424 5/24/2022
2.0.48 2,630 4/27/2022
2.0.46 897 4/24/2022
2.0.45 436 4/24/2022
2.0.44 557 4/22/2022
2.0.43 440 4/22/2022
2.0.41 451 4/22/2022
2.0.39 721 4/19/2022
2.0.38 445 4/19/2022
2.0.37 453 4/17/2022
2.0.36 444 4/17/2022
2.0.35 424 4/17/2022
2.0.34 447 4/17/2022
2.0.33 429 4/17/2022
2.0.31 429 4/16/2022
2.0.30 463 4/15/2022
2.0.29 465 4/10/2022
2.0.28 450 4/10/2022
2.0.27 424 4/10/2022
2.0.26 451 4/10/2022
2.0.25 474 4/8/2022
2.0.24 3,668 4/4/2022
2.0.23 445 4/3/2022
2.0.22 449 4/2/2022
2.0.21 452 4/2/2022
2.0.20 434 4/2/2022
2.0.19 437 4/2/2022
2.0.18 433 4/2/2022
2.0.17 471 4/1/2022
1.1.12 9,549 3/27/2022
1.1.11 479 3/26/2022
1.1.10 440 3/24/2022
1.1.9 2,032 2/25/2022
1.1.8 453 2/25/2022
1.1.7 517 2/25/2022

⭐ Last 10 features:
- feat: Add support for Enabled and Checked for ContextMenu 2022-10-13
- feat: Added support for submenu for ContextMenuMode.PopupMenu 2022-10-13
- feat: Increased max GeneratedIcon font size. Closed #39. 2022-09-16
- feat: To latest DependencyPropertyGenerator features. 2022-08-23
- feat(WPF): Added VisualStudioToolsManifest.xml. 2022-08-17
- feat: Added context menu support for core library. 2022-08-17
- feat: Added net6 trimming support. 2022-08-10
- feat: To latest DependencyPropertyGenerator. 2022-08-02
- feat: To latest DependencyPropertyGenerator. 2022-07-26
- feat: add ContextMenuMode.SecondWindow theme change handler. 2022-07-21

🐞 Last 10 bug fixes:
- fix: Added OS version check to fix NRE. 2022-11-08
- fix: Fixed bug with WPF unused code. 2022-10-13
- fix: Removed net5.0 support. 2022-10-13
- fix: Fixed some code merge problems. 2022-10-13
- fix: Fixed bug with H.Resources.Generator and Mac M1. 2022-10-13
- fix: Use SHA256.HashData when possible. 2022-10-04
- fix: Fixed EfficiencyMode exception for windows versions < 10.0.16299. Closes #40. 2022-09-23
- fix: Disabled WinRT events. Closes #36. Closes #31. 2022-08-26
- fix: Fixed #34. 2022-08-23
- fix: Fixed WinUI ContextMenuMode.PopupMenu. 2022-08-17