StructuredAutocompleteGeocoderArgs Class

Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release

An object encapsulating structured arguments for Geocode Overload.

Inheritance Hierarchy

SystemObject
Telogis.GeoBase.GeocodingAutocompleteGeocoderBaseArgs
Telogis.GeoBase.GeocodingStructuredAutocompleteGeocoderArgs

Namespace: Telogis.GeoBase.Geocoding
Assembly: geobase.net (in geobase.net.dll) Version: 4.99.0.0

Syntax

Copy

public class StructuredAutocompleteGeocoderArgs : AutocompleteGeocoderBaseArgs

Public Class StructuredAutocompleteGeocoderArgs
	Inherits AutocompleteGeocoderBaseArgs

The StructuredAutocompleteGeocoderArgs type exposes the following members.

Constructors

	Name	Description
	StructuredAutocompleteGeocoderArgs	Default constructor that creates a structured arguments object for searching within one of multiple countries.

Top

Properties

	Name	Description
	AllowedMatches	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. (Inherited from AutocompleteGeocoderBaseArgs.)
	Countries	A list of countries in which to search. This property is ignored if CountriesZone is not null. (Inherited from AutocompleteGeocoderBaseArgs.)
	CountriesZone	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. (Inherited from AutocompleteGeocoderBaseArgs.)
	Country	The Country in which to search. This property is ignored if CountriesZone is not null. (Inherited from AutocompleteGeocoderBaseArgs.)
	CrossStreet	A string representing the cross street. If set, this value is used and no cross street is parsed from StreetName.
	ExcludedResultTypes	A bitmask representing the types of results to be excluded from the current search. By default, no results are excluded. (Inherited from AutocompleteGeocoderBaseArgs.)
	IncrementalResultsCallback	Obsolete. 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. (Inherited from AutocompleteGeocoderBaseArgs.)
	LocationHint	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. (Inherited from AutocompleteGeocoderBaseArgs.)
	Postcode	The postcode to be searched.
	Regions	The regions to be searched, optionally including subregions. Must be ordered smallest to largest.
	ResultsHint	Obsolete. Deprecated. This property is ignored. (Inherited from AutocompleteGeocoderBaseArgs.)
	ResultsLimit	The maximum number of results that can be returned by any one search. The default is 5. (Inherited from AutocompleteGeocoderBaseArgs.)
	SearchDepth	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. (Inherited from AutocompleteGeocoderBaseArgs.)
	StreetName	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.
	StreetNumber	A string representing the street number. If set, this value is used and no street number is parsed from StreetName.
	Subregions	The subregions to be searched. Must be ordered smallest to largest.
	Timeout	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. (Inherited from AutocompleteGeocoderBaseArgs.)
	Units	A string representing the units. If set, this value is used and no units are parsed from StreetName.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a formatted string containing structured address information for the location to geocode. (Overrides ObjectToString.)

Top

Examples

Copy

// Create a StructureAutocompleteGeocoderArgs object
var args = new Telogis.GeoBase.Geocoding.StructuredAutocompleteGeocoderArgs {
    StreetNumber = "2",
    StreetName = "Rue Berton",
    Regions = new[] { "Saint-Quentin" },
    Postcode = "02100",
    Countries = new[] { Country.France }
};

// Pass the object to the Autocomplete Geocoder
AutocompleteGeocoderResult result = AutocompleteGeocoder.Geocode(args);

Reference

Telogis.GeoBase.Geocoding Namespace