improve clarity for SuggestionChosenEventArgs

Author: huynhsontung

Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RichSuggestBox/RichSuggestBoxPage.xaml.cs

@@ -167,11 +167,11 @@ private void SuggestingBox_OnSuggestionChosen(RichSuggestBox sender, SuggestionC
                 args.Format.ForegroundColor = Colors.OrangeRed;
                 args.Format.Bold = FormatEffect.On;
                 args.Format.Italic = FormatEffect.On;
-                args.Text = ((SampleDataType)args.SelectedItem).Text;
+                args.DisplayText = ((SampleDataType)args.SelectedItem).Text;
             }
             else
             {
-                args.Text = ((SampleEmailDataType)args.SelectedItem).DisplayName;
+                args.DisplayText = ((SampleEmailDataType)args.SelectedItem).DisplayName;
             }
         }
 

Microsoft.Toolkit.Uwp.UI.Controls.Input/RichSuggestBox/RichSuggestBox.cs

@@ -555,22 +555,23 @@ internal async Task CommitSuggestionAsync(object selectedItem)
             }
 
             var textBefore = range.Text;
+            var format = CreateTokenFormat(range);
             var eventArgs = new SuggestionChosenEventArgs
             {
                 Id = id,
                 Prefix = prefix,
                 QueryText = query,
                 SelectedItem = selectedItem,
-                Text = query,
-                Format = CreateTokenFormat(range)
+                DisplayText = query,
+                Format = format
             };
 
             if (SuggestionChosen != null)
             {
                 await SuggestionChosen.InvokeAsync(this, eventArgs);
             }
 
-            var text = eventArgs.Text;
+            var text = eventArgs.DisplayText;
 
             // Since this operation is async, the document may have changed at this point.
             // Double check if the range still has the expected query.
@@ -586,7 +587,7 @@ internal async Task CommitSuggestionAsync(object selectedItem)
                 var displayText = prefix + text;
 
                 _ignoreChange = true;
-                var committed = TryCommitSuggestionIntoDocument(range, displayText, id, eventArgs.Format);
+                var committed = TryCommitSuggestionIntoDocument(range, displayText, id, eventArgs.Format ?? format);
                 TextDocument.EndUndoGroup();
                 TextDocument.BeginUndoGroup();
                 _ignoreChange = false;

Microsoft.Toolkit.Uwp.UI.Controls.Input/RichSuggestBox/SuggestionChosenEventArgs.cs

@@ -26,7 +26,7 @@ public class SuggestionChosenEventArgs : DeferredEventArgs
         /// <summary>
         /// Gets or sets the display text.
         /// </summary>
-        public string Text { get; set; }
+        public string DisplayText { get; set; }
 
         /// <summary>
         /// Gets the suggestion item associated with this token.
@@ -39,8 +39,8 @@ public class SuggestionChosenEventArgs : DeferredEventArgs
         public Guid Id { get; internal set; }
 
         /// <summary>
-        /// Gets the formatting construct to override this token formatting.
+        /// Gets or sets the <see cref="ITextCharacterFormat"/> object used to format the display text for this token.
         /// </summary>
-        public ITextCharacterFormat Format { get; internal set; }
+        public ITextCharacterFormat Format { get; set; }
     }
 }

UITests/UITests.Tests.Shared/Controls/RichSuggestBoxTestPage.xaml.cs

@@ -27,7 +27,7 @@ private void RichSuggestBox_OnSuggestionsRequested(RichSuggestBox sender, Sugges
 
         private void RichSuggestBox_OnSuggestionsChosen(RichSuggestBox sender, SuggestionChosenEventArgs args)
         {
-            args.Text = args.QueryText + (string)args.SelectedItem;
+            args.DisplayText = args.QueryText + (string)args.SelectedItem;
         }
     }
 }

UnitTests/UnitTests.UWP/UI/Controls/Test_RichSuggestBox.cs

@@ -82,7 +82,7 @@ await App.DispatcherQueue.EnqueueAsync(async () =>
 
                 rsb.SuggestionChosen += (rsb, e) =>
                 {
-                    e.Text = expectedText.Substring(1);
+                    e.DisplayText = expectedText.Substring(1);
                     var format = e.Format;
                     format.BackgroundColor = Windows.UI.Colors.Beige;
                     format.ForegroundColor = Windows.UI.Colors.Azure;
@@ -244,7 +244,7 @@ void SuggestionChosenHandler(RichSuggestBox sender, SuggestionChosenEventArgs ar
                 suggestionChosenCalled = true;
                 Assert.AreEqual(tokenText[0].ToString(), args.Prefix, $"Unexpected prefix in {nameof(RichSuggestBox.SuggestionChosen)}.");
                 Assert.AreEqual(tokenText.Substring(1), args.QueryText, $"Unexpected query in {nameof(RichSuggestBox.SuggestionChosen)}.");
-                Assert.AreEqual(args.QueryText, args.Text, $"Unexpected display text in {nameof(RichSuggestBox.SuggestionChosen)}.");
+                Assert.AreEqual(args.QueryText, args.DisplayText, $"Unexpected display text in {nameof(RichSuggestBox.SuggestionChosen)}.");
                 Assert.AreSame(tokenText, args.SelectedItem, $"Selected item has unknown object {args.SelectedItem} in {nameof(RichSuggestBox.SuggestionChosen)}.");
             }