BingGeocodeDataProvider Class

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

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public class BingGeocodeDataProvider :
    BingMapDataProviderBase,
    IMouseClickRequestSender

VB.NET

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.

Example

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

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
            };
        }
    }

}

Form1.vb

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BingGeocodeDataProvider class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-get-information-about-a-geographical-point-using-the-microsoft-bing-geocode-web-servi-e5061/CS/RequestLocationInformation/Form1.cs#L17

BingGeocodeDataProvider geocodeProvider;

how-to-create-a-custom-geocode-panel-t188910/CS/MapControl_GeocodePanel/Form1.cs#L8

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

how-to-connect-the-map-control-to-a-ms-bing-geocode-web-service-e5060/CS/GeocodeProvider/Form1.cs#L17

GeocodeLayer.DataProvider = new BingGeocodeDataProvider() {
    BingKey = bingKey,

how-to-implement-a-route-calculator-using-gis-providers-t187741/CS/WinForms_MapControl_GIS/Form1.cs#L14

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

how-to-manually-generate-map-items-for-received-gis-data-t188443/CS/WinForms_MapControl_InformationLayer/Form1.cs#L7

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

VB.NET

how-to-create-a-custom-geocode-panel-t188910/VB/MapControl_GeocodePanel/Form1.vb#L14

End Property
Private ReadOnly Property GeocodeProvider() As BingGeocodeDataProvider
    Get

how-to-get-information-about-a-geographical-point-using-the-microsoft-bing-geocode-web-servi-e5061/VB/RequestLocationInformation/Form1.vb#L19

Private geocodeProvider As BingGeocodeDataProvider

how-to-implement-a-route-calculator-using-gis-providers-t187741/VB/WinForms_MapControl_GIS/Form1.vb#L28

End Property
Private ReadOnly Property GeocodeProvider() As BingGeocodeDataProvider
    Get

how-to-manually-generate-map-items-for-received-gis-data-t188443/VB/WinForms_MapControl_InformationLayer/Form1.vb#L13

End Property
Private ReadOnly Property GeocodeProvider() As BingGeocodeDataProvider
    Get

how-to-connect-the-map-control-to-a-ms-bing-geocode-web-service-e5060/VB/GeocodeProvider/Form1.vb#L19

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

Implements

ISupportWebRequest

IMouseClickRequestSender

Inheritance

Object

InformationDataProviderBase

WebInformationDataProvider

BingMapDataProviderBase

BingGeocodeDataProvider