InformationLayer.DataProvider Property

Provides access to an object that obtains information data from online data providers.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v19.1.dll

Declaration

C#

[DefaultValue(null)]
public InformationDataProviderBase DataProvider { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property DataProvider As InformationDataProviderBase

Property Value

Type	Default	Description
InformationDataProviderBase	*null*	An InformationDataProviderBase class descendant that is a specific data provider.

Remarks

For more information, refer to Map Image Data.

Example

This example demonstrates how to allow users to search for a specific place on a map using the Search panel.

To enable searching in the map control, do the following.

• Create an InformationLayer and add it to the map.
• Create an instance of the BingSearchDataProvider and assign it to the InformationLayer.DataProvider property.
• Specify the Bing Maps key using the BingMapDataProvider.BingKey property.

The Search panel appears automatically (since the BingSearchDataProvider.ShowSearchPanel property value is true by default).

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-a-map-control-to-the-bing-search-web-service-e5065

Form1.cs

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

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

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

        public Form1() {
            InitializeComponent();

            BingSearchDataProvider searchProvider = new BingSearchDataProvider() { 
                BingKey = bingKey 
            };

            searchProvider.SearchOptions.ResultsCount = 5;

            SearchLayer.DataProvider = searchProvider;
        }      
    }
}

Form1.vb

Imports DevExpress.XtraMap
Imports System.Windows.Forms

Namespace ConnectBingSearchProvider
    Partial Public Class Form1
        Inherits Form

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

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

        Public Sub New()
            InitializeComponent()

            Dim searchProvider As New BingSearchDataProvider() With {.BingKey = bingKey}

            searchProvider.SearchOptions.ResultsCount = 5

            SearchLayer.DataProvider = searchProvider
        End Sub
    End Class
End Namespace

Related GitHub Examples

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

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-implement-a-route-calculator-using-gis-providers-t187741/CS/WinForms_MapControl_GIS/Form1.cs#L11

InformationLayer SearchLayer { get { return (InformationLayer)mapControl1.Layers["SearchLayer"]; } }
BingSearchDataProvider SearchProvider { get { return (BingSearchDataProvider)SearchLayer.DataProvider; } }

how-to-calculate-a-distance-and-travel-time-between-waypoints-on-the-map-t239498/CS/TravelTimeDistance/Form1.cs#L18

InformationLayer RouteLayer { get { return mapControl1.Layers[1] as InformationLayer; } }
BingRouteDataProvider RouteDataProvider { get { return RouteLayer.DataProvider as BingRouteDataProvider; } }
MapItemStorage PushpinAdapter { get { return ((VectorItemsLayer)mapControl1.Layers[2]).Data as MapItemStorage; } }

how-to-calculate-a-route-between-two-addresses-t364143/CS/RouteByAddresses/Form1.cs#L18

BingRouteDataProvider provider = new BingRouteDataProvider { BingKey = yourBingKey };
informationLayer.DataProvider = provider;

how-to-calculate-a-route-between-waypoints-and-customize-the-appearance-of-a-route-path-usin-e5100/CS/ConnectToRouteService/Form1.cs#L19

routeProvider = new BingRouteDataProvider { BingKey = yourBingKey };
informationLayer.DataProvider = routeProvider;
#region #Waypoints

winforms-map-calculate-routes-from-major-roads/CS/CalculateRoutesFromMajorRoads/Form1.cs#L31

routeProvider.RouteCalculated += OnRouteCalculated;
informationLayer.DataProvider = routeProvider;
informationLayer.DataRequestCompleted += OnDataRequestCompleted;

VB.NET

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

Get
    Return CType(SearchLayer.DataProvider, BingSearchDataProvider)
End Get

how-to-calculate-a-distance-and-travel-time-between-waypoints-on-the-map-t239498/VB/TravelTimeDistance/Form1.vb#L25

Get
    Return TryCast(RouteLayer.DataProvider, BingRouteDataProvider)
End Get

how-to-calculate-a-route-between-two-addresses-t364143/VB/RouteByAddresses/Form1.vb#L20

Dim provider As BingRouteDataProvider = New BingRouteDataProvider With {.BingKey = yourBingKey}
informationLayer.DataProvider = provider

how-to-calculate-a-route-between-waypoints-and-customize-the-appearance-of-a-route-path-usin-e5100/VB/ConnectToRouteService/Form1.vb#L21

            routeProvider = New BingRouteDataProvider With {.BingKey = yourBingKey}
            informationLayer.DataProvider = routeProvider
#Region "#Waypoints"

winforms-map-calculate-routes-from-major-roads/VB/CalculateRoutesFromMajorRoads/Form1.vb#L38

AddHandler routeProvider.RouteCalculated, AddressOf OnRouteCalculated
informationLayer.DataProvider = routeProvider
AddHandler informationLayer.DataRequestCompleted, AddressOf OnDataRequestCompleted