GeocodeAsync(String,Boolean,Boolean,Boolean) Method

In This Topic

Perform a geocode operation. Geocode results are returned according to the active locator providers.

Syntax

C#
Visual Basic (Declaration)

public Task<IList<GeocodeResult>> GeocodeAsync( 
   string location,
   bool showResultsOnMap,
   bool zoomToFirstResult,
   bool showCancelPrompt
)

Public Overloads Function GeocodeAsync( _
   ByVal location As String, _
   ByVal showResultsOnMap As Boolean, _
   ByVal zoomToFirstResult As Boolean, _
   ByVal showCancelPrompt As Boolean _
) As Task(Of IList(Of GeocodeResult))

Parameters

location: The address/location to geocode.
showResultsOnMap: Should the candidate results be displayed on the active map?
zoomToFirstResult: Should the map zoom to the first candidate result?
showCancelPrompt: Set to true to show a cancelable message box

Return Value

Task of List of GeocodeResult objects. If no locators can be found then null is returned.

Remarks

If showCancelPrompt is set to true then, if GeocodeAsync is called when a previous geocode has not completed, a message box prompt asking the user if they wish to cancel the current (i.e. "previous") geocode will be shown that must be acknowledged. If showCancelPrompt is set to false no message box is shown.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.2 or higher.

Reference

LocatorManager Class
LocatorManager Members
Overload List

Send feedback