H.NotifyIcon.Uno.WinUI 2.0.77

.NET Standard 2.0
dotnet add package H.NotifyIcon.Uno.WinUI --version 2.0.77
NuGet\Install-Package H.NotifyIcon.Uno.WinUI -Version 2.0.77
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.Uno.WinUI" Version="2.0.77" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add H.NotifyIcon.Uno.WinUI --version 2.0.77
#r "nuget: H.NotifyIcon.Uno.WinUI, 2.0.77"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install H.NotifyIcon.Uno.WinUI as a Cake Addin
#addin nuget:?package=H.NotifyIcon.Uno.WinUI&version=2.0.77

// Install H.NotifyIcon.Uno.WinUI as a Cake Tool
#tool nuget:?package=H.NotifyIcon.Uno.WinUI&version=2.0.77

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 Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.77 86 1/12/2023
2.0.76 75 1/10/2023
2.0.75 79 1/5/2023
2.0.74 192 11/8/2022
2.0.73 210 10/13/2022
2.0.72 202 10/13/2022
2.0.68 216 10/4/2022
2.0.67 234 9/22/2022
2.0.66 245 9/16/2022
2.0.64 247 8/23/2022
2.0.63 248 8/17/2022
2.0.60 253 8/10/2022
2.0.59 267 8/1/2022
2.0.58 252 7/26/2022
2.0.57 281 7/21/2022
2.0.56 296 7/17/2022
2.0.55 268 7/15/2022
2.0.54 275 7/15/2022
2.0.53 295 6/24/2022
2.0.52 279 6/24/2022
2.0.51 282 6/23/2022
2.0.50 289 5/24/2022
2.0.49 271 5/24/2022
2.0.48 312 4/27/2022
2.0.46 284 4/24/2022
2.0.45 281 4/24/2022
2.0.44 287 4/22/2022
2.0.43 295 4/22/2022
2.0.41 299 4/22/2022
2.0.39 276 4/19/2022
2.0.38 286 4/19/2022
2.0.37 314 4/17/2022
2.0.36 280 4/17/2022
2.0.35 272 4/17/2022
2.0.34 308 4/17/2022
2.0.33 283 4/17/2022
2.0.31 304 4/16/2022
2.0.30 307 4/15/2022
2.0.29 308 4/10/2022
2.0.28 308 4/10/2022
2.0.27 315 4/10/2022
2.0.26 313 4/10/2022
2.0.25 308 4/8/2022
2.0.24 304 4/4/2022
2.0.23 295 4/3/2022
2.0.22 309 4/2/2022
2.0.21 282 4/2/2022
2.0.20 289 4/2/2022
2.0.19 291 4/2/2022
2.0.18 284 4/2/2022
2.0.17 316 4/1/2022

⭐ Last 10 features:
- feat: to net7.0. Updated packages. 2023-01-12
- feat: Updated CsWin32. 2023-01-12
- feat: Fixed IconSource in unpackaged not WPF apps 2023-01-11
- feat: Updated EventGenerator. 2023-01-05
- 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

🐞 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