InformationLayer.DataProvider Property

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

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v24.2.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 MapSearchPanelOptions.Visible 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“.

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#

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

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

how-to-create-a-custom-search-panel-e5084/CS/MapControl_SearchPanel/Form1.cs#L8

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

winforms-map-get-geo-point-info-from-bing-geocode-service/CS/RequestLocationInformation/Form1.cs#L33

geocodeProvider.LayerItemsGenerating += OnLayerItemsGenerating;
informationLayer.DataProvider = geocodeProvider;
#endregion #CreateGeocodeProvider

winforms-map-execute-the-search-operation-for-multiple-locations/CS/GetSearchLocationAdditionalInfo/Form1.cs#L130

searchProvider = new BingSearchDataProvider();
infoLayer.DataProvider = searchProvider;
searchProvider.GenerateLayerItems = false;

winforms-map-use-openstreetmap-search-service/CS/OsmSearchSample/MainForm.cs#L22

osmSearchDataProvider.ResultsCount = 5;
infoLayer.DataProvider = osmSearchDataProvider;

VB.NET

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

how-to-create-a-custom-search-panel-e5084/VB/MapControl_SearchPanel/Form1.vb#L18

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

winforms-map-get-geo-point-info-from-bing-geocode-service/VB/RequestLocationInformation/Form1.vb#L41

            AddHandler geocodeProvider.LayerItemsGenerating, AddressOf OnLayerItemsGenerating
            informationLayer.DataProvider = geocodeProvider
#End Region  ' #CreateGeocodeProvider

winforms-map-execute-the-search-operation-for-multiple-locations/VB/GetSearchLocationAdditionalInfo/Form1.vb#L113

searchProvider = New BingSearchDataProvider()
infoLayer.DataProvider = searchProvider
searchProvider.GenerateLayerItems = False