Skip to content
View inMAUIUWPWPFWinUIView on GitHub

Find the location for an address.

Image of find address

Use case

A user can input a raw address into your app's search bar and zoom to the address location.

How to use the sample

For simplicity, the sample comes loaded with a set of suggested addresses. Choose an address from the suggestions or submit your own address to show its location on the map in a callout.

How it works

  1. Create a LocatorTask using the URL to a locator service.
  2. Set the GeocodeParameters for the locator task and specify the geocode's attributes.
  3. Get the matching results from the GeocodeResult using locatorTask.GeocodeAsync(addressString, geocodeParameters).
  4. Create a Graphic with the geocode result's location and store the geocode result's attributes in the graphic's attributes.
  5. Show the graphic in a GraphicsOverlay.

Relevant API

  • GeocodeParameters
  • GeocodeResult
  • LocatorTask

Additional information

This sample uses the World Geocoding Service. For more information, see the Geocoding service help topic on the ArcGIS Developer website.

Tags

address, geocode, locator, search

Sample Code

FindAddress.xaml.csFindAddress.xaml.csFindAddress.xaml
Use dark colors for code blocksCopy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 // Copyright 2022 Esri. // // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. // You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific // language governing permissions and limitations under the License.  using Esri.ArcGISRuntime.Data; using Esri.ArcGISRuntime.Geometry; using Esri.ArcGISRuntime.Mapping; using Esri.ArcGISRuntime.Symbology; using Esri.ArcGISRuntime.Tasks.Geocoding; using Esri.ArcGISRuntime.UI; using System.Reflection;  namespace ArcGIS.Samples.FindAddress {  [ArcGIS.Samples.Shared.Attributes.Sample(  name: "Find address",  category: "Search",  description: "Find the location for an address.",  instructions: "For simplicity, the sample comes loaded with a set of suggested addresses. Choose an address from the suggestions or submit your own address to show its location on the map in a callout.",  tags: new[] { "address", "geocode", "locator", "search" })]  [ArcGIS.Samples.Shared.Attributes.EmbeddedResource(@"PictureMarkerSymbols\pin_star_blue.png")]  public partial class FindAddress : ContentPage  {  // Addresses for suggestion.  private readonly string[] _addresses =  {  "277 N Avenida Caballeros, Palm Springs, CA",  "380 New York St, Redlands, CA 92373",  "Београд",  "Москва",  "北京"  };   // The LocatorTask provides geocoding services  private LocatorTask _geocoder;   // Service Uri to be provided to the LocatorTask (geocoder)  private Uri _serviceUri = new Uri("https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer");   public FindAddress()  {  InitializeComponent();   // Create the UI, setup the control references and execute initialization  _ = Initialize();  MyMapView.GeoViewTapped += MyMapView_GeoViewTapped;  }   private async Task Initialize()  {  // Create new Map with basemap  Map myMap = new Map(BasemapStyle.ArcGISImagery);   // Assign the map to the MapView  MyMapView.Map = myMap;   try  {  // Initialize the LocatorTask with the provided service Uri  _geocoder = await LocatorTask.CreateAsync(_serviceUri);   // Enable the UI controls now that the LocatorTask is ready  MySuggestButton.IsEnabled = true;  MySearchBar.IsEnabled = true;  }  catch (Exception e)  {  await Application.Current.Windows[0].Page.DisplayAlert("Error", e.ToString(), "OK");  }  }   private void Handle_TextChanged(object sender, System.EventArgs e)  {  updateSearch();  }   private async void updateSearch()  {  // Get the text in the search bar  string enteredText = MySearchBar.Text;   // Clear existing marker  MyMapView.GraphicsOverlays.Clear();   // Return gracefully if the textbox is empty or the geocoder isn't ready  if (String.IsNullOrWhiteSpace(enteredText) || _geocoder == null) { return; }   try  {  // Get suggestions based on the input text  IReadOnlyList<SuggestResult> suggestions = await _geocoder.SuggestAsync(enteredText);   // Stop gracefully if there are no suggestions  if (suggestions.Count < 1) { return; }   // Get the full address for the first suggestion  SuggestResult firstSuggestion = suggestions.First();  IReadOnlyList<GeocodeResult> addresses = await _geocoder.GeocodeAsync(firstSuggestion.Label);   // Stop gracefully if the geocoder does not return a result  if (addresses.Count < 1) { return; }   // Place a marker on the map - 1. Create the overlay  GraphicsOverlay resultOverlay = new GraphicsOverlay();  // 2. Get the Graphic to display  Graphic point = await GraphicForPoint(addresses.First().DisplayLocation);  // 3. Add the Graphic to the GraphicsOverlay  resultOverlay.Graphics.Add(point);  // 4. Add the GraphicsOverlay to the MapView  MyMapView.GraphicsOverlays.Add(resultOverlay);   // Update the map extent to show the marker  MyMapView.SetViewpoint(new Viewpoint(addresses.First().Extent));  }  catch (Exception e)  {  await Application.Current.Windows[0].Page.DisplayAlert("Error", e.ToString(), "OK");  }  }   /// <summary>  /// Creates and returns a Graphic associated with the given MapPoint  /// </summary> private async Task<Graphic> GraphicForPoint(MapPoint point)  {  // Get current assembly that contains the image  Assembly currentAssembly = Assembly.GetExecutingAssembly();   // Get image as a stream from the resources  // Picture is defined as EmbeddedResource and DoNotCopy  Stream resourceStream = currentAssembly.GetManifestResourceStream(  "ArcGIS.Resources.PictureMarkerSymbols.pin_star_blue.png");   // Create new symbol using asynchronous factory method from stream  PictureMarkerSymbol pinSymbol = await PictureMarkerSymbol.CreateAsync(resourceStream);  pinSymbol.Width = 60;  pinSymbol.Height = 60;  // The image is a pin; offset the image so that the pinpoint  // is on the point rather than the image's true center  pinSymbol.LeaderOffsetX = 30;  pinSymbol.OffsetY = 14;  return new Graphic(point, pinSymbol);  }   private async void SuggestionButtonTapped(object sender, System.EventArgs e)  {  try  {  // Display the list of suggestions; returns the selected option  string action = await Application.Current.Windows[0].Page.DisplayActionSheet("Choose an address to geocode", "Cancel", null, _addresses);   if (action == "Cancel")  {  return;  }   // Update the search  MySearchBar.Text = action;  updateSearch();  }  catch (Exception ex)  {  await Application.Current.Windows[0].Page.DisplayAlert("Error", ex.Message, "OK");  }  }   /// <summary>  /// Handle tap event on the map; displays callouts showing the address for a tapped search result  /// </summary>  private async void MyMapView_GeoViewTapped(object sender, Esri.ArcGISRuntime.Maui.GeoViewInputEventArgs e)  {  try  {  // Search for the graphics underneath the user's tap  IReadOnlyList<IdentifyGraphicsOverlayResult> results = await MyMapView.IdentifyGraphicsOverlaysAsync(e.Position, 12, false);   // Return gracefully if there was no result  if (results.Count < 1 || results.First().Graphics.Count < 1) { return; }   // Reverse geocode to get addresses  IReadOnlyList<GeocodeResult> addresses = await _geocoder.ReverseGeocodeAsync(e.Location);   // Get the first result  GeocodeResult address = addresses.First();  // Use the city and region for the Callout Title  string calloutTitle = address.Attributes["City"] + ", " + address.Attributes["Region"];  // Use the metro area for the Callout Detail  string calloutDetail = address.Attributes["MetroArea"].ToString();   // Define the callout  CalloutDefinition calloutBody = new CalloutDefinition(calloutTitle, calloutDetail);   // Show the callout on the map at the tapped location  MyMapView.ShowCalloutAt(e.Location, calloutBody);  }  catch (Exception ex)  {  await Application.Current.Windows[0].Page.DisplayAlert("Error", ex.ToString(), "OK");  }  }  } }

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.