Skip to main content


  • 5 minutes to read

The Map control supports Microsoft’s Bing Geocode and the OpenStreetMap Geocode services, which provide information associated with the geographic point on a map (address, postcode, etc.) based on a point’s location (latitude and longitude coordinates).


The Bing Geocode and OpenStreetMap Geocode data providers provide the geocoding functionality and are represented by the BingGeocodeDataProvider and OsmGeocodeDataProvider classes. The sections below explain how to use the BingGeocodeDataProvider in the map control.


Due to Bing canceling the SOAP service on July 30, 2017, the Map Control’s Bing Geocode provider does not work correctly in version 16.1 and earlier.

Enabling Geocode

Do the following to enable geocoding in the Map control:

The code snippet below shows how to do this.

View Example

// Create a geocode data provider.
geocodeProvider = new BingGeocodeDataProvider {
    BingKey = yourBingKey,
    MaxVisibleResultCount = 1
geocodeProvider.LocationInformationReceived += OnLocationInformationReceived;
geocodeProvider.LayerItemsGenerating += OnLayerItemsGenerating;
informationLayer.DataProvider = geocodeProvider;

When the Map control is connected to the Bing Geocode service, you can use the pushpin’s tooltip to obtain information about a geographic point:

The image below shows a tooltip for the pushpin at “Mecklenburgh Square”.


You can also use the InformationDataProviderBase.MaxVisibleResultCount property to specify how many tooltips can be shown on a map simultaneously.

Using a Custom UI

The map control allows you to obtain additional results (address, name, entity type, etc.) from the Bing Geocode service for a specified location.


Set the InformationDataProviderBase.ProcessMouseEvents property to false if you do not want to generate pushpins when you click on the map.

To start geocoding for a location, call the BingGeocodeDataProvider.RequestLocationInformation or OsmGeocodeDataProvider.RequestLocationInformation method.

For instance, you have a UI that consists of 2 text boxes named “tbLatitude” and “tbLongitude”, and a button named “requestLocation”. To start a search, click the Request Location button. This calls the RequestLocationInformation method.

The results are stored by the RequestResultBase object’s GeocodeRequestResult descendant within the LocationInformationReceived event handler’s LocationInformationReceivedEventArgs.

The results contain the entity type, address, and coordinates associated with the geographic location.

View Example

private void requestLocation_Click(object sender, System.EventArgs e) {
    GeoPoint searchPoint;
    if(TryGetLocationArguments(out searchPoint)) {
        geocodeProvider.RequestLocationInformation(searchPoint, 0);

bool TryGetLocationArguments(out GeoPoint point) {
    double latitude;
    double longitude;
    if (
        TryConvertLocationCoordinate(teLatitude.Text, minLatitude, maxLatitude, latitudeName, out latitude) && 
        TryConvertLocationCoordinate(teLongitude.Text, minLongitude, maxLongitude, longitudeName, out longitude)) {
        point = new GeoPoint(latitude, longitude);
        return true;
    point = null;
    return false;

bool TryConvertLocationCoordinate(string str, double minValue, double maxValue, string valueName, out double value) {
    double convertedValue = String.IsNullOrEmpty(str)
        ? 0
        : Double.Parse(str);
    if((convertedValue > maxValue) || (convertedValue < minValue)) {
        MessageBox.Show(String.Format(msgMinMaxErrorFormatString, valueName, minValue, maxValue));
        value = 0;
        return false;
    value = convertedValue;
    return true;


Geocode Results

To get the geocode results for a specified location, handle the BingGeocodeDataProvider.LocationInformationReceived or OsmGeocodeDataProvider.LocationInformationReceived event. The results are stored by the RequestResultBase object’s GeocodeRequestResult descendant within the LocationInformationReceived event handler’s LocationInformationReceivedEventArgs.

The following code snippet shows how to handle the event:

View Example

private void OnLocationInformationReceived(object sender, LocationInformationReceivedEventArgs e) {
    if(e.Cancelled == true) return;
    if(e.Result.ResultCode != RequestResultCode.Success) {
        meResult.Text = "The Bing Geocode service does not work for this location.";
    StringBuilder resultList = new StringBuilder("");
    int resCounter = 1;
    foreach(LocationInformation locations in e.Result.Locations) {
        resultList.Append(String.Format("Request Result {0}:\r\n", resCounter));
        resultList.Append(String.Format(locations.EntityType + "\r\n"));
        resultList.Append(String.Format(locations.Address.FormattedAddress + "\r\n"));
        resultList.Append(String.Format("Coordinates: {0}\r\n", locations.Location));
    meResult.Text = resultList.ToString();

The results for Latitude - “41.27” and Longitude - “-96.05” are shown in the image below.



The following examples demonstrate how to use the geocode feature in the map control:

See Also