Skip to content

app-notifications-wpf.md

Latest commit

 

History

History
193 lines (141 loc) · 7.51 KB

app-notifications-wpf.md

File metadata and controls

193 lines (141 loc) · 7.51 KB
title Use app notifications with a WPF app
description Learn how to send a local app notification from a WPF app and handle the user clicking the notification using the Windows App SDK.
ms.date 04/08/2026
ms.topic how-to
keywords windows 11, windows 10, windows app sdk, winappsdk, wpf, send app notifications, notifications, toast notifications, how to, quickstart, c#, csharp
ms.localizationpriority medium

Use app notifications with a WPF app

An app notification is a UI popup that appears outside of your app's window, delivering timely information or actions to the user. Notifications can be purely informational, can launch your app when clicked, or can trigger a background action without bringing your app to the foreground.

:::image type="content" source="images/toast-notification.png" alt-text="Screenshot of an app notification":::

This article walks you through the steps to create and send an app notification from a WPF app, and then handle activation when the user interacts with it. This article uses the Windows App SDK Microsoft.Windows.AppNotifications APIs.

For an overview of app notifications and guidance for other frameworks, see App notifications overview.

This article covers local notifications. For information about delivering notifications from a cloud service, see Push notifications.

Important

Notifications for elevated (admin) apps are not currently supported.

Prerequisites

  • A WPF app targeting .NET 6 or later
  • The Windows App SDK NuGet package (Microsoft.WindowsAppSDK)

Set up your project

In your project file (.csproj), make sure the TargetFramework includes a Windows target framework:

<TargetFramework>net9.0-windows10.0.19041.0</TargetFramework>

Add the Windows App SDK NuGet package:

<PackageReference Include="Microsoft.WindowsAppSDK" Version="1.7.250310001" />

For unpackaged apps, add:

<WindowsPackageType>None</WindowsPackageType>

Register for app notifications

In your App.xaml.cs, register for notifications in the Startup event handler. You must register your NotificationInvoked handler before calling Register.

First, update App.xaml to use a Startup event handler instead of StartupUri:

App.xaml

<Application x:Class="WpfNotifications.App"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             Startup="OnStartup">
</Application>

Then, implement the startup and notification handling logic:

App.xaml.cs

using System.Windows;
using Microsoft.Windows.AppNotifications;

namespace WpfNotifications;

public partial class App : Application
{
    private void OnStartup(object sender, StartupEventArgs e)
    {
        // Register the notification handler before calling Register
        AppNotificationManager.Default.NotificationInvoked += OnNotificationInvoked;
        AppNotificationManager.Default.Register();

        // Show the main window
        var mainWindow = new MainWindow();
        mainWindow.Show();
    }

    private void OnNotificationInvoked(
        AppNotificationManager sender, 
        AppNotificationActivatedEventArgs args)
    {
        // NotificationInvoked is raised on a background thread,
        // so dispatch to the UI thread for any UI updates
        Current.Dispatcher.Invoke(() =>
        {
            // Parse args.Argument to determine what action to take.
            // args.Argument contains the arguments from the notification
            // or button that was clicked, as key=value pairs separated
            // by '&', for example "action=reply&conversationId=9813".
        });
    }

    protected override void OnExit(ExitEventArgs e)
    {
        AppNotificationManager.Default.Unregister();
        base.OnExit(e);
    }
}

Important

You must call Register before calling AppInstance.GetCurrent().GetActivatedEventArgs(). The NotificationInvoked handler must be registered before Register() is called.

Note

For unpackaged apps, Register() automatically sets up the COM server registration that allows Windows to launch your app when a notification is clicked. You don't need to configure COM activation or an AUMID manually.

Send an app notification

Use AppNotificationBuilder to construct notification content and AppNotificationManager.Show to send a notification.

MainWindow.xaml.cs

using Microsoft.Windows.AppNotifications;
using Microsoft.Windows.AppNotifications.Builder;

private void SendNotification()
{
    var notification = new AppNotificationBuilder()
        .AddArgument("action", "viewConversation")
        .AddArgument("conversationId", "9813")
        .AddText("Andrew sent you a picture")
        .AddText("Check this out, The Enchantments in Washington!")
        .BuildNotification();

    AppNotificationManager.Default.Show(notification);
}

For information about adding buttons, images, inputs, and other rich content to your notifications, see App notification content.

Packaged app setup

For unpackaged WPF apps, Register() handles COM registration automatically. For packaged apps (MSIX), you need to add the following extensions to your Package.appxmanifest:

<Package
  xmlns:com="http://schemas.microsoft.com/appx/manifest/com/windows10"
  xmlns:desktop="http://schemas.microsoft.com/appx/manifest/desktop/windows10"
  IgnorableNamespaces="... com desktop">

  <Applications>
    <Application>
      <Extensions>

        <!--Specify which CLSID to activate when notification is clicked-->
        <desktop:Extension Category="windows.toastNotificationActivation">
          <desktop:ToastNotificationActivation 
            ToastActivatorCLSID="YOUR-GUID-HERE" />
        </desktop:Extension>

        <!--Register COM CLSID-->
        <com:Extension Category="windows.comServer">
          <com:ComServer>
            <com:ExeServer 
              Executable="YourApp.exe" 
              Arguments="----AppNotificationActivated:" 
              DisplayName="YourApp">
              <com:Class Id="YOUR-GUID-HERE" />
            </com:ExeServer>
          </com:ComServer>
        </com:Extension>

      </Extensions>
    </Application>
  </Applications>
</Package>

Important

The Executable attribute should contain only the executable file name (for example, YourApp.exe), not a subdirectory path.

Related content