From 6265117611bfd5bb84a3c582c67071775fa9a1ca Mon Sep 17 00:00:00 2001
From: Marcel Wagner <marcel.alex.wagner@outlook.com>
Date: Tue, 4 Aug 2020 20:19:48 +0200
Subject: [PATCH] Fix issue with TextCommandBarFlyout not opening when using
 custom button (#3022)

* Fix issue with TextCommandBarFlyout not opening when using custom button

* Remove selectionflyout setter

* Fix crash on < RS5
---
 .../TextCommandBarFlyoutTests.cs              | 20 ++++++++++++
 .../TestUI/ExtraCommandBarFlyoutPage.xaml     |  6 ++--
 .../TestUI/ExtraCommandBarFlyoutPage.xaml.cs  | 31 ++++++++++++++++++-
 dev/CommandBarFlyout/TextCommandBarFlyout.cpp |  5 +++
 4 files changed, 59 insertions(+), 3 deletions(-)

diff --git a/dev/CommandBarFlyout/InteractionTests/TextCommandBarFlyoutTests.cs b/dev/CommandBarFlyout/InteractionTests/TextCommandBarFlyoutTests.cs
index e04d7b53e0..e9b243cb85 100644
--- a/dev/CommandBarFlyout/InteractionTests/TextCommandBarFlyoutTests.cs
+++ b/dev/CommandBarFlyout/InteractionTests/TextCommandBarFlyoutTests.cs
@@ -648,6 +648,26 @@ public void ValidateUnhandledKeysOnNonTransientFlyoutDoNotCloseFlyout()
             }
         }
 
+        [TestMethod]
+        public void VerifyTextCommandBarRemainsOpenWithItems()
+        {
+            using (var setup = new TestSetupHelper(new[] { "CommandBarFlyout Tests", "Extra CommandBarFlyout Tests" }))
+            {
+                Log.Comment("Clear the clipboard.");
+                FindElement.ById<Button>("ClearClipboardContentsButton").InvokeAndWait();
+
+                Log.Comment("Right-click on the text box with additional items.");
+                FindElement.ByName("TextBoxWithAdditionalItems").Click(PointerButtons.Secondary, 20, 20);
+
+                Wait.ForIdle();
+
+                Log.Comment("Count the number of open popups.");
+                FindElement.ById<Button>("CountPopupsButton").InvokeAndWait();
+
+                Verify.AreEqual("1", FindElement.ById<Edit>("CustomButtonsOpenCount").Value);
+            }
+        }
+
         private void OpenFlyoutOn(string textControlName, bool asTransient)
         {
             Log.Comment("Opening text control flyout on the {0} in {1} mode.", textControlName, asTransient ? "transient" : "standard");
diff --git a/dev/CommandBarFlyout/TestUI/ExtraCommandBarFlyoutPage.xaml b/dev/CommandBarFlyout/TestUI/ExtraCommandBarFlyoutPage.xaml
index 7782f06486..a92879a0ea 100644
--- a/dev/CommandBarFlyout/TestUI/ExtraCommandBarFlyoutPage.xaml
+++ b/dev/CommandBarFlyout/TestUI/ExtraCommandBarFlyoutPage.xaml
@@ -20,8 +20,8 @@
         <TextBlock Text="Demo controls" Style="{ThemeResource StandardGroupHeader}"/>
         <StackPanel Orientation="Horizontal">
             <TextBox x:Name="TextBox1" AutomationProperties.AutomationId="TextBox" ContextFlyout="{x:Bind TextCommandBarContextFlyout}"
-                     MinWidth="200" SelectionFlyout="{x:Bind TextCommandBarSelectionFlyout}" />
-            <RichTextBlock x:Name="RichTextBlock1" AutomationProperties.AutomationId="RichTextBlock" Margin="10" OverflowContentTarget="{x:Bind RichTextBlockOverflow1}" ContextFlyout="{x:Bind TextCommandBarContextFlyout}" SelectionFlyout="{x:Bind TextCommandBarSelectionFlyout}" Width="100" Height="50" HorizontalAlignment="Center">
+                     MinWidth="200" />
+            <RichTextBlock x:Name="RichTextBlock1" AutomationProperties.AutomationId="RichTextBlock" Margin="10" OverflowContentTarget="{x:Bind RichTextBlockOverflow1}" ContextFlyout="{x:Bind TextCommandBarContextFlyout}" Width="100" Height="50" HorizontalAlignment="Center">
                 <RichTextBlock.Blocks>
                     <Paragraph>
                         <Run>This is a very, very long string that cannot possibly fit within the RichTextBlock's bounds, so it overflows.</Run>
@@ -58,11 +58,13 @@
         </StackPanel>
         <TextBlock Text="Actions" Style="{ThemeResource StandardGroupHeader}" Margin="0,24,0,8"/>
         <Button AutomationProperties.AutomationId="ClearClipboardContentsButton" Content="Clear clipboard" Click="OnClearClipboardContentsClicked" />
+        <TextBox x:Name="tb" Loaded="tbloaded" Unloaded="tbunloaded" AutomationProperties.Name="TextBoxWithAdditionalItems"/>
 
         <TextBlock Text="Status" Style="{ThemeResource StandardGroupHeader}" Margin="0,24,0,8"/>
         <StackPanel Orientation="Horizontal">
             <Button AutomationProperties.AutomationId="CountPopupsButton" Content="Count popups" Click="OnCountPopupsClicked" Margin="0,0,8,0"/>
             <TextBox x:Name="PopupCountTextBox" AutomationProperties.AutomationId="PopupCountTextBox" IsReadOnly="True" />
+            <TextBox x:Name="CustomButtonsOpenCount" AutomationProperties.AutomationId="CustomButtonsOpenCount" IsReadOnly="True" />
         </StackPanel>
     </StackPanel>
 </local:TestPage>
diff --git a/dev/CommandBarFlyout/TestUI/ExtraCommandBarFlyoutPage.xaml.cs b/dev/CommandBarFlyout/TestUI/ExtraCommandBarFlyoutPage.xaml.cs
index c2a16f19d9..3f76f9d773 100644
--- a/dev/CommandBarFlyout/TestUI/ExtraCommandBarFlyoutPage.xaml.cs
+++ b/dev/CommandBarFlyout/TestUI/ExtraCommandBarFlyoutPage.xaml.cs
@@ -22,6 +22,8 @@ namespace MUXControlsTestApp
 {
     public sealed partial class ExtraCommandBarFlyoutPage : TestPage
     {
+        private int customButtonsFlyoutOpenCount = 0;
+
         public ExtraCommandBarFlyoutPage()
         {
             this.InitializeComponent();
@@ -49,7 +51,7 @@ public ExtraCommandBarFlyoutPage()
                 TextBox1.ContextFlyout = TextCommandBarContextFlyout;
                 RichTextBlock1.ContextFlyout = TextCommandBarContextFlyout;
             }
-            
+
             try
             {
                 if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.TextBox", "SelectionFlyout"))
@@ -76,6 +78,33 @@ private void OnClearClipboardContentsClicked(object sender, object args)
         private void OnCountPopupsClicked(object sender, object args)
         {
             PopupCountTextBox.Text = VisualTreeHelper.GetOpenPopups(Window.Current).Count.ToString();
+            CustomButtonsOpenCount.Text = customButtonsFlyoutOpenCount.ToString();
+        }
+
+        private void tbloaded(object sender, RoutedEventArgs e)
+        {
+            tb.ContextFlyout = new Microsoft.UI.Xaml.Controls.TextCommandBarFlyout();
+            tb.ContextFlyout.Opening += ContextFlyout_Opening;
+            tb.ContextFlyout.Closed += ContextFlyout_Closed;
+        }
+
+        private void tbunloaded(object sender, RoutedEventArgs e)
+        {
+            tb.ContextFlyout.Opening -= ContextFlyout_Opening;
+        }
+
+        private void ContextFlyout_Opening(object sender, object e)
+        {
+            customButtonsFlyoutOpenCount++;
+            var flyout = (sender as Microsoft.UI.Xaml.Controls.TextCommandBarFlyout);
+            flyout.PrimaryCommands.Add(new AppBarButton() {
+                Content = new TextBlock() { Text = "Test" }
+            });
+        }
+
+        private void ContextFlyout_Closed(object sender, object e)
+        {
+            customButtonsFlyoutOpenCount--;
         }
     }
 }
diff --git a/dev/CommandBarFlyout/TextCommandBarFlyout.cpp b/dev/CommandBarFlyout/TextCommandBarFlyout.cpp
index f5c98ae8dd..73ae8bdbb0 100644
--- a/dev/CommandBarFlyout/TextCommandBarFlyout.cpp
+++ b/dev/CommandBarFlyout/TextCommandBarFlyout.cpp
@@ -18,7 +18,12 @@ TextCommandBarFlyout::TextCommandBarFlyout()
         [this](auto const&, auto const&)
         {
             UpdateButtons();
+        }
+    });
 
+    Opened({
+        [this](auto const&, auto const&)
+        {
             // If there aren't any primary commands and we aren't opening expanded,
             // or if there are just no commands at all, then we'll have literally no UI to show. 
             // We'll just close the flyout in that case - nothing should be opening us