Update PopupViewer navigation to not change Popup property during navigation (#690)

* Update PopupViewer navigation to not change Popup property during navigation

Instead introduce readonly CurrentPopup property similar to FeatureFormView

Author: dotMorten

src/Toolkit/Toolkit/UI/Controls/PopupViewer/NavigationSubView.cs

@@ -168,11 +168,11 @@ private async Task<bool> RaiseOnNavigatingAsync(object? content, NavigationDirec
             return true;
         }
 
-        internal async Task<bool> Navigate(object? content, bool clearNavigationStack = false, bool skipRaisingEvent = false)
+        internal async Task<bool> Navigate(object? content, bool clearNavigationStack = false)
         {
             if (content is null && !clearNavigationStack)
                 throw new ArgumentNullException(nameof(content));
-            if (!skipRaisingEvent && !(await RaiseOnNavigatingAsync(content, clearNavigationStack ? NavigationDirection.Reset : NavigationDirection.Forward)))
+            if (!(await RaiseOnNavigatingAsync(content, clearNavigationStack ? NavigationDirection.Reset : NavigationDirection.Forward)))
             {
                 return false;
             }

src/Toolkit/Toolkit/UI/Controls/PopupViewer/PopupViewer.cs

@@ -127,9 +127,9 @@ private void InvalidatePopup()
                     {
                         _isDirty = false;
                     }
-                    if (Popup != null)
+                    if (CurrentPopup != null)
                     {
-                        _ = await Popup.EvaluateExpressionsAsync();
+                        _ = await CurrentPopup.EvaluateExpressionsAsync();
                     }
                 }
                 catch
@@ -138,14 +138,11 @@ private void InvalidatePopup()
             });
         }
 
-        private bool _isNavigating = false;
-
         private void SubView_OnNavigating(object? sender, NavigationSubView.NavigationEventArgs e)
         {
             if (e.Cancel)
                 return;
 
-            _isNavigating = true;
             if (e.NavigatingTo is Popup to)
             {
                 SetCurrentPopup(to);
@@ -158,35 +155,57 @@ private void SubView_OnNavigating(object? sender, NavigationSubView.NavigationEv
                     SetCurrentPopup(previousPopup);
                 }
             }
-            _isNavigating = false;
+        }
+
+        
+#if WINDOWS_XAML
+        private static readonly DependencyProperty CurrentPopupProperty =
+            DependencyProperty.Register(nameof(CurrentPopup), typeof(Popup), typeof(PopupViewer), new PropertyMetadata(null));
+#elif MAUI
+        private Popup? _currentPopup;
+#elif WPF
+        private static readonly DependencyPropertyKey CurrentPopupPropertyKey =
+                DependencyProperty.RegisterReadOnly(
+                  name: nameof(CurrentPopup),
+                  propertyType: typeof(Popup),
+                  ownerType: typeof(PopupViewer),
+                  typeMetadata: new FrameworkPropertyMetadata());
+#endif
+        private Popup? GetCurrentPopup()
+        {
+#if WINDOWS_XAML
+            return (Popup?)GetValue(CurrentPopupProperty);
+#elif WPF
+            return (Popup?)GetValue(CurrentPopupPropertyKey.DependencyProperty);
+#elif MAUI
+            return _currentPopup;
+#endif
         }
 
         private void SetCurrentPopup(Popup? value)
         {
-            var oldValue = Popup;
+            var oldValue = CurrentPopup;
             if (oldValue != value)
             {
-                SetValue(PopupProperty, value);
+#if WINDOWS_XAML
+                SetValue(CurrentPopupProperty, value);
+#elif WPF
+                SetValue(CurrentPopupPropertyKey, value);
+#elif MAUI
+                _currentPopup = value;
+                OnPropertyChanged(nameof(CurrentPopup));
+#endif
+                OnCurrentPopupPropertyChanged(oldValue, value);
             }
         }
 
-        /// <summary>
-        /// Gets or sets the associated Popup.
-        /// </summary>
-        public Popup? Popup
+        private void OnCurrentPopupPropertyChanged(Popup? oldPopup, Popup? newPopup)
         {
-            get { return GetValue(PopupProperty) as Popup; }
-            set { SetValue(PopupProperty, value); }
-        }
-
-        /// <summary>
-        /// Identifies the <see cref="PopupManager"/> dependency property.
-        /// </summary>
-        public static readonly DependencyProperty PopupProperty =
-            PropertyHelper.CreateProperty<Popup, PopupViewer>(nameof(Popup), null, (s, oldValue, newValue) => s.OnPopupPropertyChanged(oldValue, newValue));
+            if (newPopup is not null)
+            {
+                InvalidatePopup();
+            }
 
-        private void OnPopupPropertyChanged(Popup? oldPopup, Popup? newPopup)
-        {
             if (oldPopup?.GeoElement is not null)
             {
                 _dynamicEntityChangedListener?.Detach();
@@ -216,11 +235,43 @@ private void OnPopupPropertyChanged(Popup? oldPopup, Popup? newPopup)
 
                 }
             }
-            if (!_isNavigating && GetTemplateChild("SubFrameView") is NavigationSubView subView)
+            InvalidatePopup();
+        }
+
+        /// <summary>
+        /// Gets the currently active popup being viewed
+        /// </summary>
+        /// <remarks>
+        /// If you are viewing related features or utility network associations, this will return the currently active popup being viewed.
+        /// </remarks>
+        /// <seealso cref="Popup"/>
+        public Popup? CurrentPopup
+        {
+            get => GetCurrentPopup();
+        }
+
+        /// <summary>
+        /// Gets or sets the associated Popup.
+        /// </summary>
+        /// <seealso cref="CurrentPopup"/>
+        public Popup? Popup
+        {
+            get { return GetValue(PopupProperty) as Popup; }
+            set { SetValue(PopupProperty, value); }
+        }
+
+        /// <summary>
+        /// Identifies the <see cref="Popup"/> dependency property.
+        /// </summary>
+        public static readonly DependencyProperty PopupProperty =
+            PropertyHelper.CreateProperty<Popup, PopupViewer>(nameof(Popup), null, (s, oldValue, newValue) => s.OnPopupPropertyChanged(oldValue, newValue));
+
+        private void OnPopupPropertyChanged(Popup? oldPopup, Popup? newPopup)
+        {
+            if (GetTemplateChild("SubFrameView") is NavigationSubView subView)
             {
-                _ = subView.Navigate(content: Popup, clearNavigationStack: Popup is null, skipRaisingEvent: true);
+                _ = subView.Navigate(content: Popup, clearNavigationStack: true);
             }
-            InvalidatePopup();
         }
 
         /// <summary>