BingMapDataProvider.BingKey Property

Get or sets the key that is required to connect to the Bing Maps data provider.

Namespace: DevExpress.Xpf.Map

Assembly: DevExpress.Xpf.Map.v24.1.dll

NuGet Package: DevExpress.Wpf.Map

Declaration

C#

public string BingKey { get; set; }

VB.NET

Public Property BingKey As String

Property Value

Type	Description
String	A String that stores a Bing Maps key.

Remarks

For more information on obtaining a valid Bing Maps key, refer to the corresponding tutorial in this documentation: How to: Get a Bing Maps Key.

Example

This example demonstrates how to connect to the Bing Maps web service 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.

View Example

MainWindow.xaml

<Window xmlns:dxm="http://schemas.devexpress.com/winfx/2008/xaml/map"  
        x:Class="Wpf_MapControl_Lesson1.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="350" Width="525">
    <Grid>
        <dxm:MapControl CenterPoint="45,18" ZoomLevel="4" >
            <dxm:MapControl.MiniMap>
                <dxm:MiniMap Alignment="TopRight">
                    <dxm:MiniMap.Behavior>
                        <dxm:FixedMiniMapBehavior CenterPoint="45, 18"/>
                    </dxm:MiniMap.Behavior>
                    <dxm:MiniMapImageTilesLayer>
                        <dxm:BingMapDataProvider BingKey="YOUR BING KEY"/>
                    </dxm:MiniMapImageTilesLayer>
                </dxm:MiniMap>
            </dxm:MapControl.MiniMap>
            <dxm:ImageLayer>
                <dxm:ImageLayer.DataProvider>
                    <dxm:BingMapDataProvider BingKey="YOUR BING KEY"/>
                </dxm:ImageLayer.DataProvider>
            </dxm:ImageLayer>
        </dxm:MapControl>
    </Grid>
</Window>

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BingKey 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.

XAML

wpf-map-process-search-with-a-custom-search-panel/CS/MapControl_SearchPanel/MainWindow.xaml#L29

<dxm:ImageTilesLayer.DataProvider>
    <dxm:BingMapDataProvider BingKey="{Binding Source={StaticResource bingKey}}"/>
</dxm:ImageTilesLayer.DataProvider>

map-wpf-manually-load-a-cartesian-map-shapefile/CS/BuildInCoordinateConverters/MainWindow.xaml#L101

<dxm:ImageTilesLayer.DataProvider>
    <dxm:BingMapDataProvider BingKey="YourBingKey"/>
</dxm:ImageTilesLayer.DataProvider>

wpf-map-programmatically-search-with-the-bing-map-search-service/CS/DXMapExample/MainWindow.xaml#L26

<dxm:ImageTilesLayer>
    <dxm:BingMapDataProvider BingKey="{Binding Source={StaticResource bingMapsKey}}" />
</dxm:ImageTilesLayer>

wpf-map-get-routes-to-the-destination-point-with-the-bing-map-route-data-service/CS/CalculateRoutesFromMajorRoads/MainWindow.xaml#L40

    <dxm:BingMapDataProvider Kind="Road"
                             BingKey="{Binding Source={StaticResource bingKey}}"/>
</dxm:ImageTilesLayer.DataProvider>