Closing Dialog with IsOpen property now raises Closing event (#2292)

Keboo · web-flow · commit 020cea36821f · 2021-03-25T23:19:32.000-07:00
Fixes #2282
diff --git a/Directory.packages.props b/Directory.packages.props
@@ -12,7 +12,8 @@
         <PackageVersion Include="Microsoft.Composition" Version="1.0.31" />
         <PackageVersion Include="Microsoft.CSharp" Version="4.7.0" />
         <PackageVersion Include="Microsoft.NETCore.Platforms" Version="5.0.0" />
-        <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
+        <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="16.9.1" />
+        <PackageVersion Include="Microsoft.Toolkit.MVVM" Version="7.0.0" />
         <PackageVersion Include="Newtonsoft.Json" Version="12.0.3" />
         <PackageVersion Include="Shouldly" Version="3.0.2" />
         <PackageVersion Include="ShowMeTheXAML" Version="2.0.0" />
diff --git a/MainDemo.Wpf/Domain/Sample4Dialog.xaml b/MainDemo.Wpf/Domain/Sample4Dialog.xaml
@@ -4,23 +4,29 @@
              xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
              xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
              xmlns:wpf="clr-namespace:MaterialDesignThemes.Wpf;assembly=MaterialDesignThemes.Wpf"
-             mc:Ignorable="d" >
+             xmlns:domain="clr-namespace:MaterialDesignDemo.Domain"
+             d:DataContext="{d:DesignInstance Type=domain:DialogsViewModel}"
+             mc:Ignorable="d">
     <Grid Margin="16">
         <Grid.RowDefinitions>
             <RowDefinition />
             <RowDefinition />            
         </Grid.RowDefinitions>
-        <TextBox wpf:HintAssist.Hint="Name" Style="{DynamicResource MaterialDesignFloatingHintTextBox}"
+        <TextBox wpf:HintAssist.Hint="Name"
+                 Style="{StaticResource MaterialDesignFloatingHintTextBox}"
                  Margin="0 6 0 0"
                  FontSize="18" Grid.Row="0"
                  />
         <StackPanel Orientation="Horizontal" Grid.Row="1"
                     Margin="0 16 0 0">
-            <Button IsDefault="True" Style="{DynamicResource MaterialDesignFlatButton}"
+            <Button IsDefault="True"
+                    Style="{StaticResource MaterialDesignFlatButton}"
                     Command="{Binding AcceptSample4DialogCommand}">
                 ACCEPT
             </Button>
-            <Button IsCancel="True" Margin="8 0 0 0" Style="{DynamicResource MaterialDesignFlatButton}"
+            <Button IsCancel="True"
+                    Margin="8 0 0 0"
+                    Style="{StaticResource MaterialDesignFlatButton}"
                     Command="{Binding CancelSample4DialogCommand}">
                 CANCEL
             </Button>
diff --git a/MaterialDesignThemes.UITests/MaterialDesignThemes.UITests.csproj b/MaterialDesignThemes.UITests/MaterialDesignThemes.UITests.csproj
@@ -8,6 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
+    <PackageReference Include="Microsoft.Toolkit.MVVM" />
     <PackageReference Include="XAMLTest" />
     <PackageReference Include="xunit" />
     <PackageReference Include="xunit.runner.visualstudio">
diff --git a/MaterialDesignThemes.UITests/Samples/DialogHost/ClosingEventCounter.xaml b/MaterialDesignThemes.UITests/Samples/DialogHost/ClosingEventCounter.xaml
@@ -0,0 +1,31 @@
+﻿<UserControl x:Class="MaterialDesignThemes.UITests.Samples.DialogHost.ClosingEventCounter"
+             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
+             xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
+             xmlns:materialDesign="http://materialdesigninxaml.net/winfx/xaml/themes"
+             xmlns:dialogHost="clr-namespace:MaterialDesignThemes.UITests.Samples.DialogHost"
+             d:DataContext="{d:DesignInstance Type=dialogHost:ClosingEventViewModel}"
+             mc:Ignorable="d"
+             d:DesignHeight="450" d:DesignWidth="800">
+    <UserControl.DataContext>
+        <dialogHost:ClosingEventViewModel />
+    </UserControl.DataContext>
+    <materialDesign:DialogHost IsOpen="{Binding DialogIsOpen}" DialogClosing="DialogHost_DialogClosing">
+        <materialDesign:DialogHost.DialogContent>
+            <StackPanel Margin="10">
+                <TextBlock Text="Some Text" />
+                <Button Content="Close"
+                        Command="{Binding CloseDialogCommand}"
+                        x:Name="CloseButton"/>
+            </StackPanel>
+        </materialDesign:DialogHost.DialogContent>
+
+        <StackPanel VerticalAlignment="Center" HorizontalAlignment="Left">
+            <Button Content="Show Dialog"
+                    x:Name="ShowDialogButton"
+                    Command="{Binding OpenDialogCommand}"/>
+            <TextBlock x:Name="ResultTextBlock" Text="0" />
+        </StackPanel>
+    </materialDesign:DialogHost>
+</UserControl>
diff --git a/MaterialDesignThemes.UITests/Samples/DialogHost/ClosingEventCounter.xaml.cs b/MaterialDesignThemes.UITests/Samples/DialogHost/ClosingEventCounter.xaml.cs
@@ -0,0 +1,18 @@
+﻿using System.ComponentModel;
+using System.Windows.Controls;
+
+namespace MaterialDesignThemes.UITests.Samples.DialogHost
+{
+    /// <summary>
+    /// Interaction logic for ClosingEventCounter.xaml
+    /// </summary>
+    public partial class ClosingEventCounter : UserControl
+    {
+        public ClosingEventCounter()
+            => InitializeComponent();
+
+        private int _ClosingCount;
+        private void DialogHost_DialogClosing(object sender, Wpf.DialogClosingEventArgs eventArgs)
+            => ResultTextBlock.Text = (++_ClosingCount).ToString();
+    }
+}
diff --git a/MaterialDesignThemes.UITests/Samples/DialogHost/ClosingEventViewModel.cs b/MaterialDesignThemes.UITests/Samples/DialogHost/ClosingEventViewModel.cs
@@ -0,0 +1,44 @@
+﻿using System.Collections.Generic;
+using System.ComponentModel;
+using System.Runtime.CompilerServices;
+using System.Windows.Input;
+using Microsoft.Toolkit.Mvvm.Input;
+
+namespace MaterialDesignThemes.UITests.Samples.DialogHost
+{
+    public class ClosingEventViewModel : INotifyPropertyChanged
+    {
+        public event PropertyChangedEventHandler? PropertyChanged;
+
+        private bool _dialogIsOpen;
+        public bool DialogIsOpen
+        {
+            get => _dialogIsOpen;
+            set => SetProperty(ref _dialogIsOpen, value);
+        }
+
+        private ICommand? _closeDialogCommand;
+        public ICommand CloseDialogCommand => _closeDialogCommand ??= new RelayCommand(CloseDialog);
+
+        private ICommand? _openDialogCommand;
+        public ICommand OpenDialogCommand => _openDialogCommand ??= new RelayCommand(OpenDialog);
+
+        private void OpenDialog()
+            => DialogIsOpen = true;
+
+        private void CloseDialog()
+            => DialogIsOpen = false;
+
+        private bool SetProperty<T>(ref T field, T newValue, [CallerMemberName] string? propertyName = null)
+        {
+            if (!EqualityComparer<T>.Default.Equals(field, newValue))
+            {
+                field = (newValue);
+                PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
+                return true;
+            }
+
+            return false;
+        }
+    }
+}
diff --git a/MaterialDesignThemes.UITests/WPF/DialogHost/DialogHostTests.cs b/MaterialDesignThemes.UITests/WPF/DialogHost/DialogHostTests.cs
@@ -1,7 +1,9 @@
 ﻿using System;
+using System.ComponentModel;
 using System.Threading.Tasks;
 using System.Windows;
 using MaterialDesignThemes.UITests.Samples.DialogHost;
+using MaterialDesignThemes.UITests.WPF.TimePicker;
 using XamlTest;
 using Xunit;
 using Xunit.Abstractions;
@@ -44,5 +46,24 @@ public async Task OnOpenDialog_OverlayCoversContent()
             await testOverlayButton.Click();
             await Wait.For(async () => Assert.Equal("Clicks: 2", await resultTextBlock.GetText()), retry);
         }
+
+        [Fact]
+        [Description("Issue 2282")]
+        public async Task ClosingDialogWithIsOpenProperty_ShouldRaiseDialogClosingEvent()
+        {
+            await using var recorder = new TestRecorder(App);
+
+            IVisualElement dialogHost = await LoadUserControl<ClosingEventCounter>();
+            IVisualElement showButton = await dialogHost.GetElement("ShowDialogButton");
+            IVisualElement closeButton = await dialogHost.GetElement("CloseButton");
+            IVisualElement resultTextBlock = await dialogHost.GetElement("ResultTextBlock");
+
+
+            await showButton.Click();
+            await Wait.For(async () => await closeButton.GetIsVisible());
+            await closeButton.Click();
+
+            await Wait.For(async () => Assert.Equal("1", await resultTextBlock.GetText()));
+        }
     }
 }
diff --git a/MaterialDesignThemes.Wpf/DialogHost.cs b/MaterialDesignThemes.Wpf/DialogHost.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
@@ -285,8 +285,17 @@ private static void IsOpenPropertyChangedCallback(DependencyObject dependencyObj
                 object? closeParameter = null;
                 if (dialogHost.CurrentSession is { } session)
                 {
+                    if (!session.IsEnded)
+                    {
+                        session.Close(session.CloseParameter);
+                    }
+                    //DialogSession.Close may attempt to cancel the closing of the dialog.
+                    //When the dialog is closed in this manner it is not valid
+                    if (!session.IsEnded)
+                    {
+                        throw new InvalidOperationException($"Cannot cancel dialog closing after {nameof(IsOpen)} property has been set to {bool.FalseString}");
+                    }
                     closeParameter = session.CloseParameter;
-                    session.IsEnded = true;
                     dialogHost.CurrentSession = null;
                 }
                 
@@ -524,14 +533,10 @@ public event DialogOpenedEventHandler DialogOpened
             "DialogOpenedAttached", typeof(DialogOpenedEventHandler), typeof(DialogHost), new PropertyMetadata(default(DialogOpenedEventHandler)));
 
         public static void SetDialogOpenedAttached(DependencyObject element, DialogOpenedEventHandler value)
-        {
-            element.SetValue(DialogOpenedAttachedProperty, value);
-        }
+            => element.SetValue(DialogOpenedAttachedProperty, value);
 
         public static DialogOpenedEventHandler GetDialogOpenedAttached(DependencyObject element)
-        {
-            return (DialogOpenedEventHandler)element.GetValue(DialogOpenedAttachedProperty);
-        }
+            => (DialogOpenedEventHandler)element.GetValue(DialogOpenedAttachedProperty);
 
         public static readonly DependencyProperty DialogOpenedCallbackProperty = DependencyProperty.Register(
             nameof(DialogOpenedCallback), typeof(DialogOpenedEventHandler), typeof(DialogHost), new PropertyMetadata(default(DialogOpenedEventHandler)));
@@ -546,9 +551,7 @@ public DialogOpenedEventHandler? DialogOpenedCallback
         }
 
         protected void OnDialogOpened(DialogOpenedEventArgs eventArgs)
-        {
-            RaiseEvent(eventArgs);
-        }
+            => RaiseEvent(eventArgs);
 
         #endregion
 
@@ -577,14 +580,10 @@ public event DialogClosingEventHandler DialogClosing
             "DialogClosingAttached", typeof(DialogClosingEventHandler), typeof(DialogHost), new PropertyMetadata(default(DialogClosingEventHandler)));
 
         public static void SetDialogClosingAttached(DependencyObject element, DialogClosingEventHandler value)
-        {
-            element.SetValue(DialogClosingAttachedProperty, value);
-        }
+            => element.SetValue(DialogClosingAttachedProperty, value);
 
         public static DialogClosingEventHandler GetDialogClosingAttached(DependencyObject element)
-        {
-            return (DialogClosingEventHandler)element.GetValue(DialogClosingAttachedProperty);
-        }
+            => (DialogClosingEventHandler)element.GetValue(DialogClosingAttachedProperty);
 
         public static readonly DependencyProperty DialogClosingCallbackProperty = DependencyProperty.Register(
             nameof(DialogClosingCallback), typeof(DialogClosingEventHandler), typeof(DialogHost), new PropertyMetadata(default(DialogClosingEventHandler)));
@@ -599,9 +598,7 @@ public DialogClosingEventHandler? DialogClosingCallback
         }
 
         protected void OnDialogClosing(DialogClosingEventArgs eventArgs)
-        {
-            RaiseEvent(eventArgs);
-        }
+            => RaiseEvent(eventArgs);
 
         #endregion
 
@@ -616,16 +613,16 @@ internal void AssertTargetableContent()
         internal void InternalClose(object? parameter)
         {
             var currentSession = CurrentSession ?? throw new InvalidOperationException($"{nameof(DialogHost)} does not have a current session");
-            var dialogClosingEventArgs = new DialogClosingEventArgs(currentSession, DialogClosingEvent);
 
             currentSession.CloseParameter = parameter;
             currentSession.IsEnded = true;
 
             //multiple ways of calling back that the dialog is closing:
             // * routed event
             // * the attached property (which should be applied to the button which opened the dialog
-            // * straight forward dependency property 
+            // * straight forward IsOpen dependency property 
             // * handler provided to the async show method
+            var dialogClosingEventArgs = new DialogClosingEventArgs(currentSession, DialogClosingEvent);
             OnDialogClosing(dialogClosingEventArgs);
             _attachedDialogClosingEventHandler?.Invoke(this, dialogClosingEventArgs);
             DialogClosingCallback?.Invoke(this, dialogClosingEventArgs);
@@ -690,21 +687,14 @@ private void OpenDialogHandler(object sender, ExecutedRoutedEventArgs executedRo
 
                 if (_popupContentControl != null)
                 {
-                    switch (OpenDialogCommandDataContextSource)
+                    _popupContentControl.DataContext = OpenDialogCommandDataContextSource switch
                     {
-                        case DialogHostOpenDialogCommandDataContextSource.SenderElement:
-                            _popupContentControl.DataContext =
-                                (executedRoutedEventArgs.OriginalSource as FrameworkElement)?.DataContext;
-                            break;
-                        case DialogHostOpenDialogCommandDataContextSource.DialogHostInstance:
-                            _popupContentControl.DataContext = DataContext;
-                            break;
-                        case DialogHostOpenDialogCommandDataContextSource.None:
-                            _popupContentControl.DataContext = null;
-                            break;
-                        default:
-                            throw new ArgumentOutOfRangeException();
-                    }
+                        DialogHostOpenDialogCommandDataContextSource.SenderElement
+                            => (executedRoutedEventArgs.OriginalSource as FrameworkElement)?.DataContext,
+                        DialogHostOpenDialogCommandDataContextSource.DialogHostInstance => DataContext,
+                        DialogHostOpenDialogCommandDataContextSource.None => null,
+                        _ => throw new ArgumentOutOfRangeException(),
+                    };
                 }
 
                 DialogContent = executedRoutedEventArgs.Parameter;
@@ -716,9 +706,7 @@ private void OpenDialogHandler(object sender, ExecutedRoutedEventArgs executedRo
         }
 
         private void CloseDialogCanExecute(object sender, CanExecuteRoutedEventArgs canExecuteRoutedEventArgs)
-        {
-            canExecuteRoutedEventArgs.CanExecute = CurrentSession != null;
-        }
+            => canExecuteRoutedEventArgs.CanExecute = CurrentSession != null;
 
         private void CloseDialogHandler(object sender, ExecutedRoutedEventArgs executedRoutedEventArgs)
         {
@@ -730,19 +718,13 @@ private void CloseDialogHandler(object sender, ExecutedRoutedEventArgs executedR
         }
 
         private string GetStateName()
-        {
-            return IsOpen ? OpenStateName : ClosedStateName;
-        }
+            => IsOpen ? OpenStateName : ClosedStateName;
 
         private void OnUnloaded(object sender, RoutedEventArgs routedEventArgs)
-        {
-            LoadedInstances.Remove(this);
-        }
+            => LoadedInstances.Remove(this);
 
         private void OnLoaded(object sender, RoutedEventArgs routedEventArgs)
-        {
-            LoadedInstances.Add(this);
-        }
+            => LoadedInstances.Add(this);
 
     }
 }
diff --git a/MaterialDesignThemes.Wpf/DialogSession.cs b/MaterialDesignThemes.Wpf/DialogSession.cs
@@ -11,9 +11,7 @@ public class DialogSession
         private readonly DialogHost _owner;
 
         internal DialogSession(DialogHost owner)
-        {
-            _owner = owner ?? throw new ArgumentNullException(nameof(owner));
-        }
+            => _owner = owner ?? throw new ArgumentNullException(nameof(owner));
 
         /// <summary>
         /// Indicates if the dialog session has ended.  Once ended no further method calls will be permitted.
