Click or drag to resize

AutocompleteGeocoder Class

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
The AutocompleteGeocoder class takes partial address strings, and generates a list of full address suggestions. This can be used to implement an interactive address search, in which suggested addresses are displayed in near real-time as a user types.
Inheritance Hierarchy
SystemObject
  Telogis.GeoBase.GeocodingAutocompleteGeocoder

Namespace:  Telogis.GeoBase.Geocoding
Assembly:  geobase.net (in geobase.net.dll) Version: 4.83.0.0
Syntax
public class AutocompleteGeocoder

The AutocompleteGeocoder type exposes the following members.

Constructors
  NameDescription
Public methodAutocompleteGeocoder
Initializes a new instance of the AutocompleteGeocoder class
Top
Methods
  NameDescription
Public methodStatic memberCode exampleBulkGeocode
Perform a bulk geocode using an array of AutocompleteGeocoderArgs.
Public methodStatic memberCancel
Cancels any active searches. This method is designed to be called on a thread other than that from which the Geocode Overload method is called. When canceled, the Geocode Overload method will return an AutocompleteGeocoderResult with a status code of SearchCancelled.
Public methodEquals (Inherited from Object.)
Public methodStatic memberCode exampleGeocode(AutocompleteGeocoderArgs)
Generate address suggestions, based on the provided AutocompleteGeocoderArgs object.
Public methodStatic memberCode exampleGeocode(String, BoundingBox, LatLon, TimeSpan)
Generate a set of address suggestions based on the partial address string provided, searching all countries which intersect the provided BoundingBox, with an optional LatLon location hint provided to sort results based on country and proximity.
Public methodStatic memberCode exampleGeocode(String, Country, LatLon, TimeSpan)
Generate a set of address suggestions for a specific country, based on a partial address string, optionally ordered by proximity to a LatLon location hint.
Public methodStatic memberCode exampleGeocode(String, BoundingBox, LatLon, TimeSpan, ActionAutocompleteGeocoderPartialResult, AutocompleteGeocoderResultsHint) Obsolete.
Generate a set of address suggestions based on the partial address string provided, searching all countries which intersect the provided BoundingBox, with an optional LatLon location hint provided to sort results based on country and proximity.
Public methodStatic memberCode exampleGeocode(String, Country, LatLon, TimeSpan, ActionAutocompleteGeocoderPartialResult, AutocompleteGeocoderResultsHint) Obsolete.
Generate a set of address suggestions for a specific country, based on a partial address string, optionally ordered by proximity to a LatLon location hint.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
Remarks

To get the best results from AutocompleteGeocoder, search strings should comply with the following guidelines:

  • Address components should always be ordered from the most specific (e.g. street) to least specific (e.g. State).
  • Valid region names include suburbs, cities/towns and states/provinces.
  • The street component and each region component should be separated by commas.
  • The street component should consist of street name and street number, separated by white space.
  • Street numbers should consist of one or more digits, optionally followed by a letter. Valid examples are '11', '104' and '256A'.
  • The order of the street name and street number should match the conventions of the country in which you are geocoding, e.g. number then street for the USA, street then number for Brazil.
  • Building names, apartment numbers, PO box numbers and other non-standard address components should be omitted.

In addition to searching for streets, AutocompleteGeocoder can also be used to search for named regions such as suburbs, cities/towns and states/provinces. Advanced modes of AutocompleteGeocoder support using a LatLon location hint, with results ordered by proximity to this location, and searching multiple countries simultaneously, by passing in a BoundingBox object indicating which countries should be searched.

AutocompleteGeocoder is designed for use in a multi-threaded environment, with searches being carried out asynchronously on a non-UI thread. See the Autocomplete Geocoder Tutorial for an example of a threaded implementation.

See Also