Click or drag to resize

LocatorTaskSuggestAsync Method (String, SuggestParameters, CancellationToken)

Retrieves a list of possible address variants for a given partial address and set of search parameters.

Namespace:  Esri.ArcGISRuntime.Tasks.Geocoding
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.11.0
Syntax
public Task<IReadOnlyList<SuggestResult>> SuggestAsync(
	string searchText,
	SuggestParameters parameters,
	CancellationToken cancellationToken
)

Parameters

searchText
Type: SystemString
Part of address text.
parameters
Type: Esri.ArcGISRuntime.Tasks.GeocodingSuggestParameters
Suggest method parameters.
cancellationToken
Type: System.ThreadingCancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value

Type: TaskIReadOnlyListSuggestResult
A task that represents the asynchronous suggestion operation. The value of the task result contains a read-only collection of SuggestResult objects.
Remarks
Geocoding suggestions provide a mechanism for implementing character-by-character auto-complete. Using a text input and optional SuggestParameters, suggested addresses can be quickly found and presented to the user. Suggestions are not limited to addresses, they can also be used for POIs (Points of Interest). To return a focused set of suggestions, set the PreferredSearchLocation or the SearchArea. Using the PreferredSearchLocation is similar to how ArcGIS Pro limits the suggestions returned.
See Also