BingGeocodeDataProvider Class

The class that is used to send requests to the Bing Maps Geocode service.

Assembly: DevExpress.XtraMap.v20.1.dll

Declaration

C#
VB.NET

public class BingGeocodeDataProvider :
    BingMapDataProviderBase,
    IMouseClickRequestSender

Public Class BingGeocodeDataProvider
    Inherits BingMapDataProviderBase
    Implements IMouseClickRequestSender

Remarks

The Bing Geocode Data provider is represented by the BingGeocodeDataProvider object that can be accessed via the InformationLayer.DataProvider property.

If you wish to specify the number of requested results displayed, use the InformationDataProviderBase.MaxVisibleResultCount property.

Examples

This example demonstrates how to provide the capability for end-users to search an address associated with a specified location on a map and get detailed information about this place in the pushpin's tooltip, utilizing the Bing Geocode web service. Do this as follows:.

Create an InformationLayer object and add it to the MapControl.Layers collection.
Create a BingGeocodeDataProvider object, specify its properties and assign it to the InformationLayer.DataProvider property.

NOTE

Refer to How to: Get a Bing Maps Key if you run the application and see a window with the following error message: "The specified Bing Maps key is invalid. To create a developer account, refer to https://www.microsoft.com/en-us/maps/create-a-bing-maps-key".

NOTE

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-connect-the-map-control-to-a-ms-bing-geocode-web-service-e5060

Form1.cs
Form1.vb

using DevExpress.XtraMap;
using System.Windows.Forms;

namespace GeocodeProvider {
    public partial class Form1 : Form {
        const string bingKey = "YOUR BING KEY HERE";

        InformationLayer GeocodeLayer {
            get {
                return (InformationLayer)mapControl1.Layers["GeocodeLayer"];
            }
        }

        public Form1() {
            InitializeComponent();

            GeocodeLayer.DataProvider = new BingGeocodeDataProvider() {
                BingKey = bingKey,
                MaxVisibleResultCount = 1
            };
        }
    }

}

Imports DevExpress.XtraMap
Imports System.Windows.Forms

Namespace GeocodeProvider
    Partial Public Class Form1
        Inherits Form

        Private Const bingKey As String = "YOUR BING KEY HERE"

        Private ReadOnly Property GeocodeLayer() As InformationLayer
            Get
                Return CType(mapControl1.Layers("GeocodeLayer"), InformationLayer)
            End Get
        End Property

        Public Sub New()
            InitializeComponent()

            GeocodeLayer.DataProvider = New BingGeocodeDataProvider() With {.BingKey = bingKey, .MaxVisibleResultCount = 1}
        End Sub
    End Class

End Namespace