MapControl.Layers Property

Provides access to the collection of layers to be displayed within the MapControl.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v24.1.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

public LayerCollection Layers { get; }

VB.NET

Public ReadOnly Property Layers As LayerCollection

Property Value

Type	Description
LayerCollection	A LayerCollection object containing map layers.

Example

This example demonstrates how to connect to the Bing Maps using the BingMapDataProvider object.

Important

On May 21, 2024, Microsoft announced that Bing Maps for Enterprise and its API will be discontinued. Azure Maps will be a single unified enterprise mapping platform available from Microsoft.

We are working on API compatible with Azure Maps and expect to ship it with our next major release (v24.2).

If you have an existing license to Bing Maps for Enterprise, you can continue using our existing API. You need to transition to new API until June 30, 2025 (free and basic license) or until June 30, 2028 (enterprise license).

The last date you can get a new license to Bing Maps for Enterprise is June 30, 2025. If you do not have an existing license after that date, you would not be able to use our map controls with Bing Maps or Azure Maps (until we release the new API). During that time, you can use other map providers supported by our controls, such as OpenStreetMap.

Note that if you run this sample as is, you will get a warning message saying that the specified Bing Maps key is invalid. To learn more about Bing Map keys, please refer to the How to: Get a Bing Maps Key tutorial.

Form1.cs

mapControl1.Layers.Add(new ImageLayer() {
    DataProvider = new BingMapDataProvider() {
        BingKey = "YOUR BING KEY",
        Kind = BingMapKind.Road
    }
});

Form1.vb

mapControl1.Layers.Add(New ImageLayer() With {
            .DataProvider = New BingMapDataProvider() With {
                .BingKey = "YOUR BING KEY",
                .Kind = BingMapKind.Road
            }
        })

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Layers 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-create-choropleth-map-based-on-shapefile/CS/XtraMap_ShapefileDataAdapter/Form1.cs#L10

VectorItemsLayer MapLayer { get { return (VectorItemsLayer)mapControl1.Layers["MapLayer"]; } }

winforms-map-aggregate-vector-items-using-a-clusterer/CS/ClustererSample/Form1.cs#L15

#region #Clusterer
VectorItemsLayer VectorLayer { get { return (VectorItemsLayer)map.Layers["VectorLayer"]; } }
ListSourceDataAdapter DataAdapter { get { return (ListSourceDataAdapter)VectorLayer.Data; } }

how-to-convert-a-cartesian-data-shapefile-to-geo-coordinates-t543574/CS/MapSample/Form1.cs#L30

{
    VectorItemsLayer vl = this.mapControl1.Layers[0] as VectorItemsLayer;
    if (vl != null)

winforms-map-create-different-map-shapes/CS/MapItemsExample/Form1.cs#L8

const string imageFilePath = @"../../logo.png";
VectorItemsLayer VectorLayer { get { return (VectorItemsLayer)map.Layers["VectorLayer"]; } }
MapItemStorage ItemStorage { get { return (MapItemStorage)VectorLayer.Data; } }

how-to-load-data-from-a-kml-file-t140303/CS/WinForms_MapControl_KmlFileDataAdapter/Form1.cs#L9

VectorItemsLayer KmlLayer { get { return (VectorItemsLayer)mapControl1.Layers["KmlLayer"]; } }

VB.NET

winforms-map-create-choropleth-map-based-on-shapefile/VB/XtraMap_ShapefileDataAdapter/Form1.vb#L15

Get
    Return CType(Me.mapControl1.Layers("MapLayer"), DevExpress.XtraMap.VectorItemsLayer)
End Get

winforms-map-aggregate-vector-items-using-a-clusterer/VB/ClustererSample/Form1.vb#L20

Get
    Return CType(map.Layers("VectorLayer"), VectorItemsLayer)
End Get

how-to-convert-a-cartesian-data-shapefile-to-geo-coordinates-t543574/VB/MapSample/Form1.vb#L27

If dialog.ShowDialog() = System.Windows.Forms.DialogResult.OK Then
    Dim vl As VectorItemsLayer = TryCast(Me.mapControl1.Layers(0), VectorItemsLayer)
    If vl IsNot Nothing Then

winforms-map-create-different-map-shapes/VB/MapItemsExample/Form1.vb#L14

Get
    Return CType(map.Layers("VectorLayer"), VectorItemsLayer)
End Get

how-to-load-data-from-a-kml-file-t140303/VB/WinForms_MapControl_KmlFileDataAdapter/Form1.vb#L13

Get
    Return CType(mapControl1.Layers("KmlLayer"), VectorItemsLayer)
End Get