InformationLayer Class

A layer that is used to display additional information above the map.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public class InformationLayer :
    MapItemsLayerBase,
    IMapClickHandler

VB.NET

Public Class InformationLayer
    Inherits MapItemsLayerBase
    Implements IMapClickHandler

Remarks

The information layer allows you to place GIS elements (e.g., a search panel) above a map.

GIS elements can be connected to the data provider by assigning the InformationLayer.DataProvider property to the corresponding data provider type. After that, you can send and display the information requests from this provider on a GIS element.

For more information on information layer, see the Layers topic.

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

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

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

InformationLayer GeocodeLayer {
    get {

how-to-connect-a-map-control-to-the-bing-search-web-service-e5065/CS/ConnectBingSearchProvider/Form1.cs#L8

InformationLayer SearchLayer {
    get {

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

InformationLayer RouteLayer { get { return mapControl1.Layers[1] as InformationLayer; } }
BingRouteDataProvider RouteDataProvider { get { return RouteLayer.DataProvider as BingRouteDataProvider; } }

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

public partial class Form1 : Form {
    InformationLayer GeocodeLayer { get { return (InformationLayer)mapControl1.Layers["GeocodeLayer"]; } }
    BingGeocodeDataProvider GeocodeProvider { get { return (BingGeocodeDataProvider)GeocodeLayer.DataProvider; } }

VB.NET

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

#Region "#Members"
Private ReadOnly Property SearchLayer() As InformationLayer
    Get

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

Private ReadOnly Property RouteLayer() As InformationLayer
    Get

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

Private ReadOnly Property GeocodeLayer() As InformationLayer
    Get

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

Private ReadOnly Property SearchLayer() As InformationLayer
    Get

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

Private ReadOnly Property GeocodeLayer() As InformationLayer
    Get

Inheritance

Object

MapDisposableObject

LayerBase

MapItemsLayerBase

InformationLayer