Add the DialogHost close method. (#2029)

* Add the DialogHost close method.

* Resolve naming conflicts.

* Update MaterialDesignThemes.Wpf/DialogHost.cs

Co-authored-by: bombipappoo <[email protected]>

* Update MaterialDesignThemes.Wpf/DialogHost.cs

Co-authored-by: bombipappoo <[email protected]>

* Updating Close methods

* Renamed method to simply be Close

Added unit tests.

* Fixing broken unit tests

Co-authored-by: bombipappoo <[email protected]>
Co-authored-by: Kevin Bost <[email protected]>

Author: 3 people

MaterialDesignThemes.Wpf.Tests/DialogHostTests.cs

@@ -70,7 +70,7 @@ public async Task CanCloseDialogWithRoutedEvent()
             Task<object> showTask = _dialogHost.ShowDialog("Content");
             DialogSession session = _dialogHost.CurrentSession;
             Assert.False(session.IsEnded);
-            
+
             DialogHost.CloseDialogCommand.Execute(closeParameter, _dialogHost);
 
             Assert.False(_dialogHost.IsOpen);
@@ -126,7 +126,7 @@ public async Task WhenNoDialogsMatchIdentifierItThrows()
 
             var ex = await Assert.ThrowsAsync<InvalidOperationException>(() => DialogHost.Show("Content", id));
 
-            Assert.Equal($"No loaded DialogHost have an {nameof(DialogHost.Identifier)} property matching dialogIdentifier argument.", ex.Message);
+            Assert.Equal($"No loaded DialogHost have an {nameof(DialogHost.Identifier)} property matching dialogIdentifier ('{id}') argument.", ex.Message);
         }
 
         [StaFact]
@@ -142,7 +142,7 @@ public async Task WhenMultipleDialogHostsHaveTheSameIdentifierItThrows()
             otherDialogHost.RaiseEvent(new RoutedEventArgs(FrameworkElement.UnloadedEvent));
 
 
-            Assert.Equal("Multiple viable DialogHosts.  Specify a unique Identifier on each DialogHost, especially where multiple Windows are a concern.", ex.Message);
+            Assert.Equal("Multiple viable DialogHosts. Specify a unique Identifier on each DialogHost, especially where multiple Windows are a concern.", ex.Message);
         }
 
         [StaFact]
@@ -255,5 +255,69 @@ public async Task WhenClosingDialogReturnValueCanBeSpecifiedInClosingEventHandle
 
             Assert.Equal(closeParameter, await showTask);
         }
+
+        [StaFact]
+        [Description("Pull Request 2029")]
+        public void WhenClosingDialogItThrowsWhenNoInstancesLoaded()
+        {
+            _dialogHost.RaiseEvent(new RoutedEventArgs(FrameworkElement.UnloadedEvent));
+
+            var ex = Assert.Throws<InvalidOperationException>(() => DialogHost.Close(null));
+            Assert.Equal("No loaded DialogHost instances.", ex.Message);
+        }
+
+        [StaFact]
+        [Description("Pull Request 2029")]
+        public void WhenClosingDialogWithInvalidIdentifierItThrowsWhenNoMatchingInstances()
+        {
+            object id = Guid.NewGuid();
+            var ex = Assert.Throws<InvalidOperationException>(() => DialogHost.Close(id));
+            Assert.Equal($"No loaded DialogHost have an Identifier property matching dialogIdentifier ('{id}') argument.", ex.Message);
+        }
+
+        [StaFact]
+        [Description("Pull Request 2029")]
+        public void WhenClosingDialogWithMultipleDialogHostsItThrowsTooManyMatchingInstances()
+        {
+            var secondInstance = new DialogHost();
+            try
+            {
+                secondInstance.RaiseEvent(new RoutedEventArgs(FrameworkElement.LoadedEvent));
+                var ex = Assert.Throws<InvalidOperationException>(() => DialogHost.Close(null));
+                Assert.Equal("Multiple viable DialogHosts. Specify a unique Identifier on each DialogHost, especially where multiple Windows are a concern.", ex.Message);
+            }
+            finally
+            {
+                secondInstance.RaiseEvent(new RoutedEventArgs(FrameworkElement.UnloadedEvent));
+            }
+        }
+
+        [StaFact]
+        [Description("Pull Request 2029")]
+        public void WhenClosingDialogThatIsNotOpenItThrowsDialogNotOpen()
+        {
+            var ex = Assert.Throws<InvalidOperationException>(() => DialogHost.Close(null));
+            Assert.Equal("DialogHost is not open.", ex.Message);
+        }
+
+        [StaFact]
+        [Description("Pull Request 2029")]
+        public void WhenClosingDialogWithParameterItPassesParameterToHandlers()
+        {
+            object parameter = Guid.NewGuid();
+            object closingParameter = null;
+            _dialogHost.DialogClosing += DialogClosing;
+            _dialogHost.IsOpen = true;
+
+            DialogHost.Close(null, parameter);
+
+            Assert.Equal(parameter, closingParameter);
+
+            void DialogClosing(object sender, DialogClosingEventArgs eventArgs)
+            {
+                closingParameter = eventArgs.Parameter;
+            }
+        }
+
     }
 }

MaterialDesignThemes.Wpf/DialogHost.cs

@@ -166,19 +166,46 @@ public static Task<object> Show(object content, object dialogIdentifier, DialogC
         /// <returns>Task result is the parameter used to close the dialog, typically what is passed to the <see cref="CloseDialogCommand"/> command.</returns>
         public static async Task<object> Show(object content, object dialogIdentifier, DialogOpenedEventHandler openedEventHandler, DialogClosingEventHandler closingEventHandler)
         {
-            if (content == null) throw new ArgumentNullException(nameof(content));
+            if (content is null) throw new ArgumentNullException(nameof(content));
+            return await GetInstance(dialogIdentifier).ShowInternal(content, openedEventHandler, closingEventHandler);
+        }
+
+        /// <summary>
+        ///  Close a modal dialog.
+        /// </summary>
+        /// <param name="dialogIdentifier"> of the instance where the dialog should be closed. Typically this will match an identifer set in XAML. </param>
+        public static void Close(object dialogIdentifier)
+            => Close(dialogIdentifier, null);
 
+        /// <summary>
+        ///  Close a modal dialog.
+        /// </summary>
+        /// <param name="dialogIdentifier"> of the instance where the dialog should be closed. Typically this will match an identifer set in XAML. </param>
+        /// <param name="parameter"> to provide to close handler</param>
+        public static void Close(object dialogIdentifier, object parameter)
+        {
+            DialogHost dialogHost = GetInstance(dialogIdentifier);
+            if (dialogHost.CurrentSession is { } currentSession)
+            {
+                currentSession.Close(parameter);
+                return;
+            }
+            throw new InvalidOperationException("DialogHost is not open.");
+        }
+
+        private static DialogHost GetInstance(object dialogIdentifier)
+        {
             if (LoadedInstances.Count == 0)
                 throw new InvalidOperationException("No loaded DialogHost instances.");
             LoadedInstances.First().Dispatcher.VerifyAccess();
 
             var targets = LoadedInstances.Where(dh => dialogIdentifier == null || Equals(dh.Identifier, dialogIdentifier)).ToList();
             if (targets.Count == 0)
-                throw new InvalidOperationException($"No loaded DialogHost have an {nameof(Identifier)} property matching {nameof(dialogIdentifier)} argument.");
+                throw new InvalidOperationException($"No loaded DialogHost have an {nameof(Identifier)} property matching {nameof(dialogIdentifier)} ('{dialogIdentifier}') argument.");
             if (targets.Count > 1)
-                throw new InvalidOperationException("Multiple viable DialogHosts.  Specify a unique Identifier on each DialogHost, especially where multiple Windows are a concern.");
+                throw new InvalidOperationException("Multiple viable DialogHosts. Specify a unique Identifier on each DialogHost, especially where multiple Windows are a concern.");
 
-            return await targets[0].ShowInternal(content, openedEventHandler, closingEventHandler);
+            return targets[0];
         }
 
         internal async Task<object> ShowInternal(object content, DialogOpenedEventHandler openedEventHandler, DialogClosingEventHandler closingEventHandler)
@@ -579,7 +606,7 @@ internal void AssertTargetableContent()
                     "Content cannot be passed to a dialog via the OpenDialog if DialogContent already has a binding.");
         }
 
-        internal void Close(object parameter)
+        internal void InternalClose(object parameter)
         {
             var dialogClosingEventArgs = new DialogClosingEventArgs(CurrentSession, DialogClosingEvent);
 
@@ -636,7 +663,7 @@ protected override void OnPreviewMouseDown(MouseButtonEventArgs e)
         private void ContentCoverGridOnMouseLeftButtonUp(object sender, MouseButtonEventArgs mouseButtonEventArgs)
         {
             if (CloseOnClickAway && CurrentSession != null)
-                Close(CloseOnClickAwayParameter);
+                InternalClose(CloseOnClickAwayParameter);
         }
 
         private void OpenDialogHandler(object sender, ExecutedRoutedEventArgs executedRoutedEventArgs)
@@ -689,7 +716,7 @@ private void CloseDialogHandler(object sender, ExecutedRoutedEventArgs executedR
         {
             if (executedRoutedEventArgs.Handled) return;
 
-            Close(executedRoutedEventArgs.Parameter);
+            InternalClose(executedRoutedEventArgs.Parameter);
 
             executedRoutedEventArgs.Handled = true;
         }

MaterialDesignThemes.Wpf/DialogSession.cs

@@ -55,7 +55,7 @@ public void Close()
         {
             if (IsEnded) throw new InvalidOperationException("Dialog session has ended.");
 
-            _owner.Close(null);
+            _owner.InternalClose(null);
         }
 
         /// <summary>
@@ -67,7 +67,7 @@ public void Close(object parameter)
         {
             if (IsEnded) throw new InvalidOperationException("Dialog session has ended.");
 
-            _owner.Close(parameter);
+            _owner.InternalClose(parameter);
         }
     }
 }