Location Class

Location Class

Contains the representation of a location.

Public Class Location
    Member of [Namespace]
[C#]
public class Location : System.Object
    Member of [Namespace]

Public Properties

public propertyAddress The address (Address object) for the location, if available.
public propertyBestMapView Representations of the view of the map (MapViewRepresentations object) for the location.
public propertyDataSourceName A string representing the name of the data source (DataSource.Name property) in which the specified Entity property, if any, exists. String.
public propertyEntity The geographic entity (Entity object) for the location.
public propertyLatLong The latitude and longitude coordinates (LatLong object) for the location or for the center point of the location if the location represents an area.

Remarks

Each of the Location properties can be null; however, the Location object is not valid unless it contains at least one of the following properties: Address, Entity, or LatLong.

Every Location property may be populated.

If there is conflict between any of the Location properties passed into a method, the method uses the Entity property. If the Entity property is null, the method uses the LatLong property. If both the Entity and LatLong properties are null, the method uses the Address property.

On output, the Location object is:

  • returned from the FindServiceSoap.GetLocationInfo method.
  • used in the FindResult.FoundLocation property returned from the Find, FindAddress, FindByID, FindByProperty, FindNearby, or FindNearRoute methods of the FindServiceSoap class.
  • used in the Waypoint.CalculatedLocation property returned from the CalculateRoute and CalculateSimpleRoute methods of the RouteServiceSoap class.

On input, the Location object is used with:

  • the locations parameter of the RenderServiceSoap.GetBestMapView method.
  • the ViewByBoundingLocations.Locations property, which is passed to the RenderServiceSoap.GetMap method using the MapSpecification.Views property.
  • the Waypoint.Location property, which is used with the SegmentSpecification.Waypoint property passed in the RouteSpecification.Segments property to the RouteServiceSoap.CalculateRoute method.

See Also

Address Class | MapViewRepresentations Class | DataSource.Name Property | Entity Class | LatLong Class | FindServiceSoap.GetLocationInfo Method | FindResult.FoundLocation Property | FindServiceSoap.Find Method | FindServiceSoap.FindAddress Method | FindServiceSoap.FindNearby Method | FindServiceSoap.FindByID Method | FindServiceSoap.FindByProperty Method | FindServiceSoap.FindNearRoute Method | Waypoint.CalculatedLocation Property | RouteServiceSoap.CalculateRoute Method | RouteServiceSoap.CalculateSimpleRoute Method | RenderServiceSoap.GetBestMapView Method | ViewByBoundingLocations.Locations Property | RenderServiceSoap.GetMap Method | MapSpecification.Views Property | Waypoint.Location Property | SegmentSpecification.Waypoint Property | RouteSpecification.Segments Property