Search View

src/Toolkit.Forms/SearchView/SearchView.cs

@@ -285,8 +285,7 @@ private async Task ConfigureForCurrentMap()
 
             try
             {
-                SearchViewModel.Sources.Clear();
-                SearchViewModel.Sources.Add(await LocatorSearchSource.CreateDefaultSourceAsync());
+                await SearchViewModel.ConfigureDefaultWorldGeocoder();
             }
             catch (Exception)
             {

src/Toolkit/Toolkit.UWP/UI/Controls/SearchView/SearchView.Theme.xaml

@@ -612,11 +612,7 @@
                     <TextBlock
                         Style="{StaticResource ResultMessageStyle}"
                         Text="{TemplateBinding NoResultMessage}"
-                        Visibility="{Binding SearchViewModel.Suggestions.Count, Mode=OneWay, Converter={StaticResource CollectionIsEmptyToBoolConverter}, ConverterParameter='Empty', FallbackValue=Collapsed}" />
-                    <TextBlock
-                        Style="{StaticResource ResultMessageStyle}"
-                        Text="{TemplateBinding NoResultMessage}"
-                        Visibility="{Binding SearchViewModel.Results.Count, Mode=OneWay, Converter={StaticResource CollectionIsEmptyToBoolConverter}, ConverterParameter='Empty', FallbackValue=Collapsed}" />
+                        Visibility="{Binding ResultMessageVisibility, Mode=OneWay}" />
                 </Grid>
             </Border>
             <Popup

src/Toolkit/Toolkit.WPF/UI/Controls/SearchView/SearchView.Theme.xaml

@@ -8,7 +8,6 @@
     <converter:CollectionIsSingletonToBoolConverter x:Key="CollectionIsSingletonToBoolConverter" />
     <converter:BoolToVisibilityConverter x:Key="BoolToVisibilityConverter" />
     <converter:NullToBoolSelectionConverter x:Key="NullToBoolSelectionConverter" />
-    <converter:CollectionIsEmptyToVisibilityConverter x:Key="CollectionIsEmptyToVisibilityConverter" />
     <Color x:Key="ButtonHoverColor">#f3f3f3</Color>
     <Color x:Key="ButtonPressColor">#e2f1fb</Color>
     <Color x:Key="BlueButtonColor">#007AC2</Color>
@@ -529,17 +528,7 @@
                             <Border
                                 BorderThickness="0,1,0,0"
                                 Style="{StaticResource ResultAreaBorderStyle}"
-                                Visibility="{Binding SearchViewModel.Results.Count, Mode=OneWay, Converter={StaticResource CollectionIsEmptyToVisibilityConverter}, ConverterParameter='Empty'}">
-                                <TextBlock
-                                    Margin="8"
-                                    HorizontalAlignment="Center"
-                                    VerticalAlignment="Center"
-                                    Text="{TemplateBinding NoResultMessage}" />
-                            </Border>
-                            <Border
-                                BorderThickness="0,1,0,0"
-                                Style="{StaticResource ResultAreaBorderStyle}"
-                                Visibility="{Binding SearchViewModel.Suggestions.Count, Mode=OneWay, Converter={StaticResource CollectionIsEmptyToVisibilityConverter}, ConverterParameter='Empty'}">
+                                Visibility="{Binding ResultMessageVisibility, Mode=OneWay}">
                                 <TextBlock
                                     Margin="8"
                                     HorizontalAlignment="Center"

src/Toolkit/Toolkit/UI/Controls/SearchView/LocatorSearchSource.cs

@@ -52,8 +52,7 @@ public static async Task<LocatorSearchSource> CreateDefaultSourceAsync(Cancellat
             return new WorldGeocoderSearchSource(_worldGeocoderTask, null);
         }
 
-        private bool _loading;
-        private bool _hasPerformedInitialLoad;
+        protected Task? _loadTask;
 
         /// <summary>
         /// Gets or sets the name of the locator. Defaults to the locator's name, or "locator" if not set.
@@ -118,6 +117,11 @@ public static async Task<LocatorSearchSource> CreateDefaultSourceAsync(Cancellat
         /// <inheritdoc />
         public MapPoint? PreferredSearchLocation { get; set; }
 
+        /// <summary>
+        /// Gets or sets the attribute key to use as the subtitle when returning results. Key must be included in <see cref="GeocodeParameters.ResultAttributeNames"/>.
+        /// </summary>
+        public string? SubtitleAttributKey { get; set; }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="LocatorSearchSource"/> class.
         /// <seealso cref="SmartLocatorSearchSource"/> for a search source with advanced features intended for use with the World Geocoder Service.
@@ -127,20 +131,12 @@ public LocatorSearchSource(LocatorTask locator)
         {
             Locator = locator;
 
-            _ = EnsureLoaded();
+            _loadTask = EnsureLoaded();
         }
 
         private async Task EnsureLoaded()
         {
-            // TODO = find a better way of handling this
-            if (_loading || _hasPerformedInitialLoad)
-            {
-                return;
-            }
-            else
-            {
-                _loading = true;
-            }
+            await Locator.LoadAsync();
 
             Stream? resourceStream = Assembly.GetAssembly(typeof(LocatorSearchSource))?.GetManifestResourceStream(
                 "Esri.ArcGISRuntime.Toolkit.EmbeddedResources.pin_red.png");
@@ -155,24 +151,12 @@ private async Task EnsureLoaded()
                 DefaultSymbol = pinSymbol;
             }
 
-            if (!_hasPerformedInitialLoad && Locator.LoadStatus != LoadStatus.Loaded)
+            if (DisplayName != Locator?.LocatorInfo?.Name && !string.IsNullOrWhiteSpace(Locator?.LocatorInfo?.Name))
             {
-                // TODO = decide how to handle locators that throw.
-                await Locator.LoadAsync();
+                DisplayName = Locator?.LocatorInfo?.Name ?? "Locator";
             }
 
-            if (!_hasPerformedInitialLoad)
-            {
-                if (DisplayName != Locator?.LocatorInfo?.Name && !string.IsNullOrWhiteSpace(Locator?.LocatorInfo?.Name))
-                {
-                    DisplayName = Locator?.LocatorInfo?.Name ?? "Locator";
-                }
-
-                GeocodeParameters.ResultAttributeNames.Add("*");
-            }
-
-            _hasPerformedInitialLoad = true;
-            _loading = false;
+            GeocodeParameters.ResultAttributeNames.Add("*");
         }
 
         /// <summary>
@@ -194,7 +178,7 @@ public virtual void NotifyDeselected(SearchResult? result)
         /// <inheritdoc/>
         public virtual async Task<IList<SearchSuggestion>> SuggestAsync(string queryString, CancellationToken cancellationToken = default)
         {
-            await EnsureLoaded();
+            await _loadTask;
 
             cancellationToken.ThrowIfCancellationRequested();
 
@@ -211,7 +195,7 @@ public virtual async Task<IList<SearchSuggestion>> SuggestAsync(string queryStri
         /// <inheritdoc/>
         public virtual async Task<IList<SearchResult>> SearchAsync(SearchSuggestion suggestion, CancellationToken cancellationToken = default)
         {
-            await EnsureLoaded();
+            await _loadTask;
 
             cancellationToken.ThrowIfCancellationRequested();
 
@@ -225,7 +209,7 @@ public virtual async Task<IList<SearchResult>> SearchAsync(SearchSuggestion sugg
         /// <inheritdoc/>
         public virtual async Task<IList<SearchResult>> SearchAsync(string queryString, CancellationToken cancellationToken = default)
         {
-            await EnsureLoaded();
+            await _loadTask;
 
             cancellationToken.ThrowIfCancellationRequested();
 
@@ -243,7 +227,7 @@ public virtual async Task<IList<SearchResult>> SearchAsync(string queryString, C
         /// <inheritdoc />
         public virtual async Task<IList<SearchResult>> RepeatSearchAsync(string queryString, Envelope queryExtent, CancellationToken cancellationToken = default)
         {
-            await EnsureLoaded();
+            await _loadTask;
 
             cancellationToken.ThrowIfCancellationRequested();
 
@@ -284,8 +268,14 @@ private IList<SearchSuggestion> SuggestionToSearchSuggestion(IReadOnlyList<Sugge
         /// </summary>
         private SearchResult GeocodeResultToSearchResult(GeocodeResult r)
         {
+            string? subtitle = null;
+            if (SubtitleAttributKey != null && r.Attributes.ContainsKey(SubtitleAttributKey))
+            {
+                subtitle = r.Attributes[SubtitleAttributKey]?.ToString();
+            }
+
             Mapping.Viewpoint? selectionViewpoint = r.Extent == null ? null : new Mapping.Viewpoint(r.Extent);
-            return new SearchResult(r.Label, null, this, new Graphic(r.DisplayLocation, r.Attributes, DefaultSymbol), selectionViewpoint) { CalloutDefinition = DefaultCalloutDefinition };
+            return new SearchResult(r.Label, subtitle, this, new Graphic(r.DisplayLocation, r.Attributes, DefaultSymbol), selectionViewpoint) { CalloutDefinition = DefaultCalloutDefinition };
         }
 
         /// <summary>

src/Toolkit/Toolkit/UI/Controls/SearchView/SearchResult.cs

@@ -89,7 +89,6 @@ public GeoElement? GeoElement
                     PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(GeoElement)));
 
                     // Start loading image
-                    // TODO = decide if it would be better to expose a top-level symbol property
                     if (_geoElement is Graphic graphic && graphic.Symbol is Symbol symbol)
                     {
                         _ = LoadImage(symbol);
@@ -139,8 +138,6 @@ public SearchResult(string title, string? subtitle, ISearchSource owner, GeoElem
             SelectionViewpoint = viewpoint;
         }
 
-        // TODO - cache these operations; multiple roundtrips to core for images is not fast
-
         /// <summary>
         /// Gets the image displayed for this result.
         /// </summary>

src/Toolkit/Toolkit/UI/Controls/SearchView/SearchView.cs

@@ -26,6 +26,7 @@
 using Esri.ArcGISRuntime.UI;
 using Esri.ArcGISRuntime.UI.Controls;
 using System.Collections.ObjectModel;
+using System.Collections.Specialized;
 #if !NETFX_CORE
 using System.Windows;
 using System.Windows.Controls;
@@ -124,7 +125,7 @@ private void SuggestionList_SelectionChanged(object sender, SelectionChangedEven
 
         private async Task ConfigureForCurrentMap()
         {
-            if (!EnableAutomaticConfiguration)
+            if (!EnableDefaultWorldGeocoder)
             {
                 return;
             }
@@ -138,8 +139,7 @@ private async Task ConfigureForCurrentMap()
 
             try
             {
-                SearchViewModel.Sources.Clear();
-                SearchViewModel.Sources.Add(await LocatorSearchSource.CreateDefaultSourceAsync(_configurationCancellationToken.Token));
+                await SearchViewModel.ConfigureDefaultWorldGeocoder(_configurationCancellationToken.Token);
             }
             catch (Exception)
             {
@@ -223,6 +223,22 @@ public Visibility SourceSelectVisibility
             }
         }
 
+        /// <summary>
+        /// Gets the visibility for the presentation of the <see cref="NoResultMessage"/>.
+        /// </summary>
+        public Visibility ResultMessageVisibility
+        {
+            get
+            {
+                if (SearchViewModel?.Suggestions?.Count == 0 || SearchViewModel?.Results?.Count == 0)
+                {
+                    return Visibility.Visible;
+                }
+
+                return Visibility.Collapsed;
+            }
+        }
+
         /// <summary>
         /// Gets or sets a value indicating whether the source selection view is being displayed.
         /// </summary>
@@ -276,7 +292,7 @@ private static void OnViewModelChanged(DependencyObject d, DependencyPropertyCha
                 if (e.OldValue is SearchViewModel oldModel)
                 {
                     oldModel.PropertyChanged -= sendingView.SearchViewModel_PropertyChanged;
-                    if (oldModel.Sources is ObservableCollection<ISearchSource> oldSources)
+                    if (oldModel.Sources is INotifyCollectionChanged oldSources)
                     {
                         oldSources.CollectionChanged -= sendingView.Sources_CollectionChanged;
                     }
@@ -285,7 +301,7 @@ private static void OnViewModelChanged(DependencyObject d, DependencyPropertyCha
                 if (e.NewValue is SearchViewModel newModel)
                 {
                     newModel.PropertyChanged += sendingView.SearchViewModel_PropertyChanged;
-                    if (newModel.Sources is ObservableCollection<ISearchSource> newSources)
+                    if (newModel.Sources is INotifyCollectionChanged newSources)
                     {
                         newSources.CollectionChanged += sendingView.Sources_CollectionChanged;
                     }
@@ -432,6 +448,7 @@ private async Task HandleResultsCollectionChanged()
             }
 
             NotifyPropertyChange(nameof(ResultViewVisibility));
+            NotifyPropertyChange(nameof(ResultMessageVisibility));
 
             if (SearchViewModel.Results == null)
             {
@@ -541,12 +558,12 @@ public SearchViewModel? SearchViewModel
         }
 
         /// <summary>
-        /// Gets or sets a value indicating whether <see cref="SearchView"/> will automatically configure search settings based on the associated <see cref="GeoView"/>'s <see cref="GeoModel"/>.
+        /// Gets or sets a value indicating whether <see cref="SearchViewModel"/> will include the Esri World Geocoder service by default.
         /// </summary>
-        public bool EnableAutomaticConfiguration
+        public bool EnableDefaultWorldGeocoder
         {
-            get => (bool)GetValue(EnableAutomaticConfigurationProperty);
-            set => SetValue(EnableAutomaticConfigurationProperty, value);
+            get => (bool)GetValue(EnableDefaultWorldGeocoderProperty);
+            set => SetValue(EnableDefaultWorldGeocoderProperty, value);
         }
 
         /// <summary>
@@ -651,10 +668,10 @@ public string? RepeatSearchButtonText
             DependencyProperty.Register(nameof(GeoView), typeof(GeoView), typeof(SearchView), new PropertyMetadata(null, OnGeoViewPropertyChanged));
 
         /// <summary>
-        /// Identifies the <see cref="EnableAutomaticConfiguration"/> dependency property.
+        /// Identifies the <see cref="EnableDefaultWorldGeocoder"/> dependency property.
         /// </summary>
-        public static readonly DependencyProperty EnableAutomaticConfigurationProperty =
-            DependencyProperty.Register(nameof(EnableAutomaticConfiguration), typeof(bool), typeof(SearchView), new PropertyMetadata(true));
+        public static readonly DependencyProperty EnableDefaultWorldGeocoderProperty =
+            DependencyProperty.Register(nameof(EnableDefaultWorldGeocoder), typeof(bool), typeof(SearchView), new PropertyMetadata(true));
 
         /// <summary>
         /// Identifies the <see cref="EnableRepeatSearchHereButton"/> dependency proeprty.
@@ -718,6 +735,7 @@ public string? RepeatSearchButtonText
         private void HandleSuggestionsChanged()
         {
             NotifyPropertyChange(nameof(ResultViewVisibility));
+            NotifyPropertyChange(nameof(ResultMessageVisibility));
             #if NETFX_CORE
             UpdateGroupingForUWP();
             #endif

src/Toolkit/Toolkit/UI/Controls/SearchView/SearchViewModel.cs

@@ -249,10 +249,6 @@ public async Task CommitSearch()
 
                 ApplyNewResult(allResults.SelectMany(l => l).ToList(), null);
             }
-            catch (Exception)
-            {
-                // TODO - decide on error handling
-            }
             finally
             {
                 _activeSearchCancellation = null;
@@ -295,10 +291,6 @@ public async Task RepeatSearchHere()
 
                 ApplyNewResult(allResults.SelectMany(l => l).ToList(), _lastSuggestion);
             }
-            catch (Exception)
-            {
-                // TODO - decide how to handle exceptions.
-            }
             finally
             {
                 _activeSearchCancellation = null;
@@ -378,10 +370,6 @@ public async Task AcceptSuggestion(SearchSuggestion suggestion)
 
                 ApplyNewResult(results, suggestion);
             }
-            catch (Exception)
-            {
-                // TODO - decide how to report.
-            }
             finally
             {
                 _activeSearchCancellation = null;
@@ -475,6 +463,16 @@ public void CancelSuggestion()
             _activeSuggestCancellation?.Cancel();
         }
 
+        /// <summary>
+        /// Configures the viewmodel with a search source optimized for use with the Esri World Geocoder service.
+        /// </summary>
+        /// <param name="token">Token used for cancellation.</param>
+        public async Task ConfigureDefaultWorldGeocoder(CancellationToken token = default)
+        {
+            Sources.Clear();
+            Sources.Add(await LocatorSearchSource.CreateDefaultSourceAsync(token));
+        }
+
         private List<ISearchSource> SourcesToSearch()
         {
             var selectedSources = new List<ISearchSource>();