StructuredAutocompleteGeocoderArgs Properties

Determines how strictly address candidates are matched against the search query. For example, MatchLevel.Strict can be used when results must closely match the search query, not allowing for errors like spelling mistakes or nearby regions. The default is AllowedMatches.Permissive, which does not impose any restrictions on candidate matching.

A list of countries in which to search. This property is ignored if CountriesZone is not null.

A BoundingBox that determines which countries to search. All countries falling within this BoundingBox are included in the search. Note that this does not limit the search to only those regions of the country covered by the BoundingBox. If a value of null is passed for this parameter, and Country is set to Country.Unknown, then all available countries are searched.

The Country in which to search. This property is ignored if CountriesZone is not null.

A string representing the cross street. If set, this value is used and no cross street is parsed from StreetName.

A bitmask representing the types of results to be excluded from the current search. By default, no results are excluded.

A callback to receive incremental results as they are found, in addition to receiving the full results list on return. This property is deprecated, and is included only for backwards compatibility. If a callback is provided, it is called only once with the full results of the geocode operation.

An optional LatLon value. The location hint adds a bias towards nearby results when there are more results than the results limit, and also influences the ranking of results. If you do not want to use a location hint, set this parameter to Empty.

The postcode to be searched.

The regions to be searched, optionally including subregions. Must be ordered smallest to largest.

Deprecated. This property is ignored.

The maximum number of results that can be returned by any one search. The default is 5.

Determines the desired effort to find results; higher depths can result in better quality or more results, but can take longer to complete. The default is SearchDepth.Medium.

A string representing the street name, optionally containing units, street number, or cross street. Note that if any of these properties are set separately (e.g. StreetNumber), they are not parsed from this property.

A string representing the street number. If set, this value is used and no street number is parsed from StreetName.

The subregions to be searched. Must be ordered smallest to largest.

Specifies how long the search should continue before terminating prematurely. Specifying a timeout of TimeSpan.Zero means that the search will not timeout. When a search times out, the AutocompleteGeocoderResult object returned contains all suggestions found prior to the timeout and has a status of Timeout.

A string representing the units. If set, this value is used and no units are parsed from StreetName.