Click or drag to resize

StructuredLocationSearchArgs Class

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
An object encapsulating structured arguments for LocationSearch(LocationSearchBaseArgs).
Inheritance Hierarchy
SystemObject
  Telogis.GeoBase.GeocodingLocationSearchBaseArgs
    Telogis.GeoBase.GeocodingStructuredLocationSearchArgs

Namespace:  Telogis.GeoBase.Geocoding
Assembly:  geobase.net (in geobase.net.dll) Version: 4.99.0.0
Syntax
public class StructuredLocationSearchArgs : LocationSearchBaseArgs

The StructuredLocationSearchArgs type exposes the following members.

Constructors
  NameDescription
Public methodStructuredLocationSearchArgs
Initializes a new instance of the StructuredLocationSearchArgs class
Top
Properties
  NameDescription
Public propertyCountries
A list of countries in which to search. An empty array indicates to search all countries (which might not be supported by some search sources). The default is all countries.
(Inherited from LocationSearchBaseArgs.)
Public propertyCrossStreet
A string representing the cross street.
Public propertyCustomArgs
A dictionary of custom arguments specific to custom search sources. This could be used, for example, to provide authentication details or customer information for a custom search source that needs to authenticate with an external server or provides customer-specific results. The default is an empty dictionary.
(Inherited from LocationSearchBaseArgs.)
Public propertyLocationHint
An optional LatLon value that adds a bias towards nearby results. The default is Empty.
(Inherited from LocationSearchBaseArgs.)
Public propertyPoiTypes
For searches that include POI results, restrict the types of POI to search to those in the PoiTypes array. The default is an empty array, which includes all POI types.
(Inherited from LocationSearchBaseArgs.)
Public propertyPostcode
The postcode to be searched.
Public propertyQueryForm
The query's form; that is whether it is a prefix query or a complete query. This provides a hint as to which search sources should be used. For example, a prefix query is likely to be handled by a different geocoder than a full query. The default is QueryForm.Prefix.
(Inherited from LocationSearchBaseArgs.)
Public propertyRegions
The regions to be searched, greater than city level.
Public propertyResultsLimit
The maximum number of results that can be returned by any one search. The default is 5.
(Inherited from LocationSearchBaseArgs.)
Public propertyResultTypes
The types of results to search for and return.
(Inherited from LocationSearchBaseArgs.)
Public propertySearchDepth
A hint as to the desired depth of the search. A low depth is best suited to user interfaces that need to be highly responsive; a high depth is best suited to contexts where high quality results are particularly important, at the sacrifice of search speed. The default is SearchDepth.Medium.
(Inherited from LocationSearchBaseArgs.)
Public propertyStreetName
A string representing the street name.
Public propertyStreetNumber
A string representing the street number.
Public propertySubregions
The subregions to be searched, city level or smaller.
Public propertyTimeout
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 LocationSearchResult object returned contains all suggestions found prior to the timeout and has a status of Timeout.
(Inherited from LocationSearchBaseArgs.)
Public propertyUnits
A string representing the units.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a formatted string containing structured address information for the location to search for.
(Overrides ObjectToString.)
Top
See Also