feat: improve ToastNotification

Author: davidkallesen

src/Atc.Wpf.Controls/Extensions/ToastNotificationContentExtensions.cs

@@ -0,0 +1,16 @@
+// ReSharper disable once CheckNamespace
+namespace Atc.Wpf.Controls;
+
+public static class ToastNotificationContentExtensions
+{
+    public static ToastNotificationContent ToToastNotificationContent(
+        this ToastNotificationMessage message)
+    {
+        ArgumentNullException.ThrowIfNull(message);
+
+        return new ToastNotificationContent(
+            message.ToastNotificationType,
+            message.Title,
+            message.Message);
+    }
+}

src/Atc.Wpf.Controls/Extensions/ToastNotificationMessageExtensions.cs

@@ -0,0 +1,16 @@
+// ReSharper disable once CheckNamespace
+namespace Atc.Wpf.Controls;
+
+public static class ToastNotificationMessageExtensions
+{
+    public static ApplicationEventEntry ToApplicationEventEntry(
+        this ToastNotificationMessage message)
+    {
+        ArgumentNullException.ThrowIfNull(message);
+
+        return new ApplicationEventEntry(
+            message.ToastNotificationType.ToLogCategoryType(),
+            message.Title,
+            message.Message);
+    }
+}

src/Atc.Wpf.Controls/Extensions/ToastNotificationTypeExtensions.cs

@@ -0,0 +1,17 @@
+// ReSharper disable once CheckNamespace
+namespace Atc.Wpf.Controls;
+
+public static class ToastNotificationTypeExtensions
+{
+    public static LogCategoryType ToLogCategoryType(
+        this ToastNotificationType toastNotificationType)
+    {
+        return toastNotificationType switch
+        {
+            ToastNotificationType.Information or ToastNotificationType.Success => LogCategoryType.Information,
+            ToastNotificationType.Warning => LogCategoryType.Warning,
+            ToastNotificationType.Error => LogCategoryType.Error,
+            _ => throw new SwitchCaseDefaultException(toastNotificationType),
+        };
+    }
+}

src/Atc.Wpf.Controls/GlobalUsings.cs

@@ -53,6 +53,9 @@
 global using Atc.Wpf.Controls.LabelControls.Writers;
 global using Atc.Wpf.Controls.Layouts.Grid.Internal;
 global using Atc.Wpf.Controls.Media;
+global using Atc.Wpf.Controls.Monitoring;
+global using Atc.Wpf.Controls.Notifications;
+global using Atc.Wpf.Controls.Notifications.Messages;
 global using Atc.Wpf.Controls.Options;
 global using Atc.Wpf.Controls.Progressing.Internal;
 global using Atc.Wpf.Controls.Resources;

src/Atc.Wpf.Controls/Monitoring/ApplicationMonitorViewModel.cs

@@ -9,6 +9,7 @@ public sealed class ApplicationMonitorViewModel : ViewModelBase
     private bool autoScroll;
     private ApplicationEventEntry? selectedEntry;
     private ListSortDirection sortDirection;
+    private bool listenOnToastNotificationMessage;
 
     public ApplicationMonitorViewModel()
     {
@@ -117,6 +118,30 @@ public string MatchOnText
         }
     }
 
+    public bool ListenOnToastNotificationMessage
+    {
+        get => listenOnToastNotificationMessage;
+        set
+        {
+            if (value == listenOnToastNotificationMessage)
+            {
+                return;
+            }
+
+            listenOnToastNotificationMessage = value;
+            RaisePropertyChanged();
+
+            if (listenOnToastNotificationMessage)
+            {
+                MessengerInstance.Register<ToastNotificationMessage>(this, OnToastNotificationMessageHandler);
+            }
+            else
+            {
+                MessengerInstance.UnRegister<ToastNotificationMessage>(this, OnToastNotificationMessageHandler);
+            }
+        }
+    }
+
     public void AddEntry(
         ApplicationEventEntry entry)
     {
@@ -147,6 +172,17 @@ private void OnApplicationEventEntryHandler(
         ApplicationEventEntry entry)
         => AddEntry(entry);
 
+    private void OnToastNotificationMessageHandler(
+        ToastNotificationMessage message)
+    {
+        if (!ListenOnToastNotificationMessage)
+        {
+            return;
+        }
+
+        AddEntry(message.ToApplicationEventEntry());
+    }
+
     private void ClearCommandHandler()
     {
         lock (SyncLock)

src/Atc.Wpf.Controls/Notifications/IToastNotificationManager.cs

@@ -4,7 +4,7 @@ public interface IToastNotificationManager
 {
     void Show(
         bool useDesktop,
-        object content,
+        UserControl content,
         string areaName = "",
         TimeSpan? expirationTime = null,
         Action? onClick = null,

src/Atc.Wpf.Controls/Notifications/ToastNotificationArea.cs

@@ -49,15 +49,16 @@ public override void OnApplyTemplate()
 
     [SuppressMessage("AsyncUsage", "AsyncFixer03:Fire-and-forget async-void methods or delegates", Justification = "OK - Need 'async void' and not 'async Task'")]
     [SuppressMessage("Major Bug", "S3168:\"async\" methods should not return \"void\"", Justification = "OK - Need 'async void' and not 'async Task'")]
+    [SuppressMessage("ReSharper", "AsyncVoidMethod", Justification = "OK - Need 'async void' and not 'async Task'")]
     public async void Show(
-        object content,
+        ContentControl contentControl,
         TimeSpan expirationTime,
         Action? onClick,
         Action? onClose)
     {
         var toastNotification = new ToastNotification
         {
-            Content = content,
+            Content = contentControl,
         };
 
         toastNotification.MouseLeftButtonDown += (sender, _) =>

src/Atc.Wpf.Controls/Notifications/ToastNotificationContent.cs

@@ -1,6 +1,24 @@
 namespace Atc.Wpf.Controls.Notifications;
 
-public record ToastNotificationContent(
-    ToastNotificationType Type,
-    string Title,
-    string Message);
+public class ToastNotificationContent(
+    ToastNotificationType type,
+    string title,
+    string message)
+    : UserControl
+{
+    public ToastNotificationType Type { get; init; } = type;
+
+    public string Title { get; init; } = title;
+
+    public string Message { get; init; } = message;
+
+    public void Deconstruct(
+        out ToastNotificationType type,
+        out string title,
+        out string message)
+    {
+        type = Type;
+        title = Title;
+        message = Message;
+    }
+}

src/Atc.Wpf.Controls/Notifications/ToastNotificationManager.cs

@@ -3,19 +3,50 @@ namespace Atc.Wpf.Controls.Notifications;
 public sealed class ToastNotificationManager : IToastNotificationManager
 {
     private readonly Dispatcher dispatcher;
-    private static readonly List<ToastNotificationArea> Areas = new();
+    private static readonly List<ToastNotificationArea> Areas = [];
     private static ToastNotificationsOverlayWindow? window;
 
-    public ToastNotificationManager(Dispatcher? dispatcher = null)
+    public ToastNotificationManager(
+        Dispatcher? dispatcher = null)
     {
         dispatcher ??= Application.Current?.Dispatcher ?? Dispatcher.CurrentDispatcher;
         this.dispatcher = dispatcher;
     }
 
+    public void Show(
+        bool useDesktop,
+        ToastNotificationMessage message,
+        string areaName = "",
+        TimeSpan? expirationTime = null,
+        Action? onClick = null,
+        Action? onClose = null)
+        => Show(
+            useDesktop,
+            message.ToToastNotificationContent(),
+            areaName,
+            expirationTime,
+            onClick,
+            onClose);
+
+    public void Show(
+        bool useDesktop,
+        ToastNotificationContent content,
+        string areaName = "",
+        TimeSpan? expirationTime = null,
+        Action? onClick = null,
+        Action? onClose = null)
+        => Show(
+            useDesktop,
+            (UserControl)content,
+            areaName,
+            expirationTime,
+            onClick,
+            onClose);
+
     [SuppressMessage("Critical Code Smell", "S2696:Instance members should not write to \"static\" fields", Justification = "OK.")]
     public void Show(
         bool useDesktop,
-        object content,
+        UserControl content,
         string areaName = "",
         TimeSpan? expirationTime = null,
         Action? onClick = null,
@@ -25,7 +56,14 @@ public void Show(
 
         if (!dispatcher.CheckAccess())
         {
-            _ = dispatcher.BeginInvoke(new Action(() => Show(useDesktop, content, areaName, expirationTime, onClick, onClose)));
+            _ = dispatcher.BeginInvoke(
+                new Action(() => Show(
+                    useDesktop,
+                    content,
+                    areaName,
+                    expirationTime,
+                    onClick,
+                    onClose)));
             return;
         }
 
@@ -47,19 +85,27 @@ public void Show(
             areaName = "DesktopArea";
         }
 
-        var toastNotificationAreas = Areas.Where(a => a.Name == areaName).ToArray();
+        var toastNotificationAreas = Areas
+            .Where(a => a.Name == areaName)
+            .ToArray();
+
         if (!toastNotificationAreas.Any())
         {
             toastNotificationAreas = Areas.Where(a => a.Name != "DesktopArea").ToArray();
         }
 
         foreach (var area in toastNotificationAreas)
         {
-            area.Show(content, (TimeSpan)expirationTime, onClick, onClose);
+            area.Show(
+                content,
+                (TimeSpan)expirationTime,
+                onClick,
+                onClose);
         }
     }
 
-    internal static void AddArea(ToastNotificationArea area)
+    internal static void AddArea(
+        ToastNotificationArea area)
     {
         Areas.Add(area);
     }

src/Atc.Wpf.Controls/Notifications/ToastNotificationTemplateSelector.cs

@@ -12,9 +12,12 @@ private void GetTemplatesFromResources(
         defaultToastNotificationTemplate = container?.FindResource("DefaultToastNotificationTemplate") as DataTemplate;
     }
 
-    public override DataTemplate? SelectTemplate(object item, DependencyObject container)
+    public override DataTemplate? SelectTemplate(
+        object? item,
+        DependencyObject container)
     {
-        if (defaultStringTemplate == null && defaultToastNotificationTemplate == null)
+        if (defaultStringTemplate is null &&
+            defaultToastNotificationTemplate is null)
         {
             GetTemplatesFromResources((FrameworkElement)container);
         }