ESRI.ArcGIS.ADF.Web.DataSources.ArcGISServer
GetLocatorProperties Method
See Also 
ESRI.ArcGIS.ADF.Web.DataSources.ArcGISServer Namespace > GeocodeFunctionality Class : GetLocatorProperties Method




Gets the properties of the locator, which may be modified and passed when performing geocoding.

Syntax

Visual Basic (Declaration) 
Public Function GetLocatorProperties() As Dictionary(Of String, Object)
Visual Basic (Usage)Copy Code
Dim instance As GeocodeFunctionality
Dim value As Dictionary(Of String, Object)
 
value = instance.GetLocatorProperties()
C# 
public Dictionary<string, object> GetLocatorProperties()

Example

For an example of using GetLocatorProperties(), see the GeocodeFunctionality overview.

Remarks

This method obtains a generic Dictionary of properties used when performing geocoding. These properties govern how the server performs geocoding. You may modify the locator properties and pass them with the overloaded version of either GeocodeAddress or FindAddressCandidates that accepts the properties (propMods).

The properties will include three properties also exposed as MapFunctionality properties: MinCandidateScore, MinMatchScore. But other properties that may be available in the locator include such items as:

  • MatchIfScoresTie: if true, returns a location if two or more locations tie for top match score; if false, no result returned if locations tie.
  • SideOffset: distance to offset the x,y from the linear (street) segment (useful so points are on the correct side of the street)
  • SideOffsetUnits: units for the SideOffset distance
  • EndOffset: distance to offset locations from the end of the linear segment (useful so geocoded point does not fall on adjoining street)
  • IntersectionConnectors: characters (such as &, |, @) recognized as intersection markers, enabling geocoding of intersection values such as "Oak St. & First Ave."
  • WritePercentAlongField, WriteStandardizedAddressField, WriteXYCoordFields: whether to include these fields in the results of the geocoding operation.

You must examine the items in locator properties to determine what properties are available for modification for geocoding.

See Also

© 2010 All Rights Reserved.