Class
BingRestMapProvider

Represents the Bing REST Map Provider class.

Definition

Namespace:Telerik.Windows.Controls.Map

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:

cs-api-definition
[Obsolete("This class is obsolete and will be deleted in Q2 2026.")]
public class BingRestMapProvider : TiledProvider, IDisposable, IBingRestSearchLocationProvider, IBingRestRouteProvider, IBingRestTruckRouteProvider, IBingRestElevationProvider, ICloneable

Inheritance: objectMapProviderBaseTiledProviderBingRestMapProvider

Implements: IBingRestElevationProviderIBingRestRouteProviderIBingRestSearchLocationProviderIBingRestTruckRouteProviderICloneableIDisposable

Inherited Members TiledProvider.IsTileCachingEnabledPropertyTiledProvider.CacheStoragePropertyTiledProvider.RequestCacheLevelPropertyTiledProvider.RequestCredentialsPropertyTiledProvider.IsTileCachingEnabledChanged(bool, bool)TiledProvider.CacheStorageChanged()TiledProvider.RequestCacheLevelChanged()TiledProvider.RequestCredentialsChanged()TiledProvider.InheritParameters(MapProviderBase)TiledProvider.InheritCacheStorage(TiledMapSource)TiledProvider.OnIsTileCachingEnabledChanged(bool, bool)TiledProvider.InheritRequestCacheLevel(TiledMapSource)TiledProvider.InheritRequestCredentials(TiledMapSource)TiledProvider.IsTileCachingEnabledTiledProvider.CacheStorageTiledProvider.RequestCacheLevelTiledProvider.RequestCredentialsMapProviderBase.GeoBoundsPropertyMapProviderBase.GeoBoundsNWPropertyMapProviderBase.GeoBoundsSEPropertyMapProviderBase.OpacityPropertyMapProviderBase.Dispose()MapProviderBase.GetValidatedGeoPoint(Location)MapProviderBase.SetMapSource(string)MapProviderBase.TryGetMapSource(string, out IMapSource)MapProviderBase.CreateInstanceCore()MapProviderBase.InheritCurrentSource(MapProviderBase)MapProviderBase.RegisterSetSourceCommand(Type, string, DataTemplate, Uri, CanExecuteRoutedEventHandler, ExecutedRoutedEventHandler)MapProviderBase.SourceInitializationFaulted(object, InitializationFaultEventArgs)MapProviderBase.CommandBindingCollectionMapProviderBase.CommandsMapProviderBase.GeoBoundsMapProviderBase.GeoBoundsNWMapProviderBase.GeoBoundsSEMapProviderBase.OpacityMapProviderBase.SupportedSourcesMapProviderBase.MapSourcesMapProviderBase.InitializationFaultedMapProviderBase.MapSourceChangedMapProviderBase.SpatialReferenceChanged

Constructors

BingRestMapProvider()

Initializes a new instance of the BingRestMapProvider class.

Declaration

cs-api-definition
public BingRestMapProvider()

BingRestMapProvider(MapMode, BingTopLayer, string, bool)

Initializes a new instance of the BingRestMapProvider class.

Declaration

cs-api-definition
public BingRestMapProvider(MapMode mode, BingTopLayer topLayer, string applicationId, bool useSession)

Parameters

mode

MapMode

Map mode.

topLayer

BingTopLayer

Bing top layer option.

applicationId

string

Bing Maps Key.

useSession

bool

Value which indicates whether Bing session should be used.

BingRestMapProvider(MapMode, bool, string)

Initializes a new instance of the BingRestMapProvider class.

Declaration

cs-api-definition
public BingRestMapProvider(MapMode mode, bool labelVisible, string applicationId)

Parameters

mode

MapMode

Map mode.

labelVisible

bool

Is labels visible.

applicationId

string

Bing Maps Key.

BingRestMapProvider(MapMode, bool, string, bool)

Initializes a new instance of the BingRestMapProvider class.

Declaration

cs-api-definition
public BingRestMapProvider(MapMode mode, bool labelVisible, string applicationId, bool useSession)

Parameters

mode

MapMode

Map mode.

labelVisible

bool

Is labels visible.

applicationId

string

Bing Maps Key.

useSession

bool

Value which indicates whether Bing session should be used.

BingRestMapProvider(string)

Initializes a new instance of the BingRestMapProvider class.

Declaration

cs-api-definition
public BingRestMapProvider(string applicationId)

Parameters

applicationId

string

Bing Maps Key.

Fields

IsLabelVisibleProperty

Identifies the IsLabelVisible dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsLabelVisibleProperty

Field Value

DependencyProperty

ModeProperty

Identifies the Mode dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ModeProperty

Field Value

DependencyProperty

TopLayerProperty

Identifies the TopLayer dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TopLayerProperty

Field Value

DependencyProperty

UseSessionProperty

Identifies the UseSession dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty UseSessionProperty

Field Value

DependencyProperty

Properties

ApplicationId

Gets or sets Bing application ID.

Declaration

cs-api-definition
public string ApplicationId { get; set; }

Property Value

string

IsLabelVisible

Gets or sets value which indicates whether labels should be visible on the map.

Declaration

cs-api-definition
public bool IsLabelVisible { get; set; }

Property Value

bool

Mode

Gets or sets map mode.

Declaration

cs-api-definition
public MapMode Mode { get; set; }

Property Value

MapMode

SpatialReference

Returns the SpatialReference for the map provider.

Declaration

cs-api-definition
public override ISpatialReference SpatialReference { get; }

Property Value

ISpatialReference

Overrides MapProviderBase.SpatialReference

TopLayer

Gets or sets the top layer option of the Bing rest imagery service. Runtime change is not supported.

Declaration

cs-api-definition
public BingTopLayer TopLayer { get; set; }

Property Value

BingTopLayer

UseSession

Gets or sets value which indicates whether Bing session should be used. Make sense during provider initialization only.

Declaration

cs-api-definition
public bool UseSession { get; set; }

Property Value

bool

Methods

ApplySourceModes(string)

Apply map source modes.

Declaration

cs-api-definition
protected override string ApplySourceModes(string uniqueId)

Parameters

uniqueId

string

Base source unique ID.

Returns

string

Unique ID of the map source with applied modes.

Overrides MapProviderBase.ApplySourceModes(string)

Remarks

Some providers (Bing, for example) can have different modes for the same base source (arial with/without labels in Bing, for example). This method allows apply this kind of modes to the base source.

BuildElevationRequestUri(BingRestElevationRequest)

Builds a string URI based on the BingRestElevationRequest.

Declaration

cs-api-definition
protected virtual Uri BuildElevationRequestUri(BingRestElevationRequest request)

Parameters

request

BingRestElevationRequest

Returns

Uri

BuildRoutingRequestUri(BingRestRouteRequest)

Builds a string URI based on the BingRestRouteRequest.

Declaration

cs-api-definition
protected virtual Uri BuildRoutingRequestUri(BingRestRouteRequest request)

Parameters

request

BingRestRouteRequest

Returns

Uri

BuildSearchLocationRequestUri(BingRestSearchLocationRequest)

Creates a string URI based on the BingRestSearchLocationRequest.

Declaration

cs-api-definition
protected virtual Uri BuildSearchLocationRequestUri(BingRestSearchLocationRequest request)

Parameters

request

BingRestSearchLocationRequest

Returns

Uri

BuildTruckRouteRequestBody(BingRestTruckRouteRequest)

Builds a JSON body based on the BingRestTruckRouteRequest

Declaration

cs-api-definition
protected virtual string BuildTruckRouteRequestBody(BingRestTruckRouteRequest request)

Parameters

request

BingRestTruckRouteRequest

The request to build the JSON for.

Returns

string

BuildTruckRouteVehicleSpecsBody(BingRestVehicleSpec)

Builds a JSON body based on the BingRestVehicleSpec

Declaration

cs-api-definition
protected virtual string BuildTruckRouteVehicleSpecsBody(BingRestVehicleSpec spec)

Parameters

spec

BingRestVehicleSpec

The vehicle spec.

Returns

string

BuildTruckRoutingRequestUri(BingRestTruckRouteRequest)

Builds a string URI based on the BingRestTruckRouteRequest.

Declaration

cs-api-definition
protected virtual Uri BuildTruckRoutingRequestUri(BingRestTruckRouteRequest request)

Parameters

request

BingRestTruckRouteRequest

Returns

Uri

CalculateElevationAsync(BingRestElevationRequest)

Performs async elevation request. Calculates elevation for given list of latitude and longitude pairs. Alternatively can calculate the elevation of equally spaced points along a polyline.

Declaration

cs-api-definition
public void CalculateElevationAsync(BingRestElevationRequest request)

Parameters

request

BingRestElevationRequest

Elevation request.

Implements IBingRestElevationProvider.CalculateElevationAsync(BingRestElevationRequest)

CalculateRouteAsync(BingRestRouteRequest)

Calculates the route specified by the BingRestRouteRequest.

Declaration

cs-api-definition
public void CalculateRouteAsync(BingRestRouteRequest request)

Parameters

request

BingRestRouteRequest

Implements IBingRestRouteProvider.CalculateRouteAsync(BingRestRouteRequest)

CalculateTruckRouteAsync(BingRestTruckRouteRequest)

Calculates the truck route specified by the BingRestRouteRequest.

Declaration

cs-api-definition
public void CalculateTruckRouteAsync(BingRestTruckRouteRequest request)

Parameters

request

BingRestTruckRouteRequest

Implements IBingRestTruckRouteProvider.CalculateTruckRouteAsync(BingRestTruckRouteRequest)

Clone()

Implements the ICloneable interface.

Declaration

cs-api-definition
public object Clone()

Returns

object

Cloned object.

Implements ICloneable.Clone()

Dispose(bool)

Called by the Dispose() and Finalize() methods to release the unmanaged resources used by the current instance of the BingRestMapProvider class.

Declaration

cs-api-definition
protected override void Dispose(bool disposing)

Parameters

disposing

bool

True to release unmanaged and managed resources; false to release only unmanaged resources.

Overrides MapProviderBase.Dispose(bool)

GetPointsString(List<Location>)

Builds locations string used in the service request.

Declaration

cs-api-definition
protected virtual string GetPointsString(List<Location> points)

Parameters

points

List<Location>

Returns

string

OnCalculateElevationCompleted(BingRestElevationCompletedEventArgs)

Called when calculation of elevation is completed.

Declaration

cs-api-definition
protected virtual void OnCalculateElevationCompleted(BingRestElevationCompletedEventArgs e)

Parameters

e

BingRestElevationCompletedEventArgs

OnCalculateElevationCompleted(object, DownloadStringCompletedEventArgs)

Called when calculation of elevation is completed.

Declaration

cs-api-definition
protected virtual void OnCalculateElevationCompleted(object sender, DownloadStringCompletedEventArgs e)

Parameters

sender

object

e

DownloadStringCompletedEventArgs

OnCalculateElevationError(BingRestCalculateElevationErrorEventArgs)

Called when calculation of elevation returns error.

Declaration

cs-api-definition
protected virtual void OnCalculateElevationError(BingRestCalculateElevationErrorEventArgs e)

Parameters

e

BingRestCalculateElevationErrorEventArgs

OnCalculateRouteCompleted(BingRestRoutingCompletedEventArgs)

Called when the calculation of route is completed.

Declaration

cs-api-definition
protected virtual void OnCalculateRouteCompleted(BingRestRoutingCompletedEventArgs e)

Parameters

e

BingRestRoutingCompletedEventArgs

OnCalculateRouteCompleted(object, DownloadStringCompletedEventArgs)

Called when calculation of route is completed.

Declaration

cs-api-definition
protected virtual void OnCalculateRouteCompleted(object sender, DownloadStringCompletedEventArgs e)

Parameters

sender

object

e

DownloadStringCompletedEventArgs

OnCalculateRouteError(BingRestCalculateRouteErrorEventArgs)

Called when the calculation of route produces an error.

Declaration

cs-api-definition
protected virtual void OnCalculateRouteError(BingRestCalculateRouteErrorEventArgs e)

Parameters

e

BingRestCalculateRouteErrorEventArgs

OnCalculateTruckRouteCompleted(BingRestRoutingCompletedEventArgs)

Called when the calculation of a truck route is completed.

Declaration

cs-api-definition
protected virtual void OnCalculateTruckRouteCompleted(BingRestRoutingCompletedEventArgs e)

Parameters

e

BingRestRoutingCompletedEventArgs

OnCalculateTruckRouteCompleted(object, UploadStringCompletedEventArgs)

Called when calculation of route is completed.

Declaration

cs-api-definition
protected virtual void OnCalculateTruckRouteCompleted(object sender, UploadStringCompletedEventArgs e)

Parameters

sender

object

e

UploadStringCompletedEventArgs

OnCalculateTruckRouteError(BingRestCalculateRouteErrorEventArgs)

Called when the calculation of a truck route results in an error.

Declaration

cs-api-definition
protected virtual void OnCalculateTruckRouteError(BingRestCalculateRouteErrorEventArgs e)

Parameters

e

BingRestCalculateRouteErrorEventArgs

OnPreviewSourceChange(IMapSource)

Called before map provider switch to another map source.

Declaration

cs-api-definition
protected override bool OnPreviewSourceChange(IMapSource source)

Parameters

source

IMapSource

Map source which will be used.

Returns

bool

Overrides MapProviderBase.OnPreviewSourceChange(IMapSource)

OnPreviewSourceChanged(IMapSource)

Called after map provider switch to another map source.

Declaration

cs-api-definition
protected override void OnPreviewSourceChanged(IMapSource source)

Parameters

source

IMapSource

Map source is used.

Overrides MapProviderBase.OnPreviewSourceChanged(IMapSource)

OnSearchLocationCompleted(BingRestSearchLocationCompletedEventArgs)

Called when the search is completed.

Declaration

cs-api-definition
protected virtual void OnSearchLocationCompleted(BingRestSearchLocationCompletedEventArgs e)

Parameters

e

BingRestSearchLocationCompletedEventArgs

OnSearchLocationError(BingRestSearchLocationErrorEventArgs)

Called when search error occurs.

Declaration

cs-api-definition
protected virtual void OnSearchLocationError(BingRestSearchLocationErrorEventArgs e)

Parameters

e

BingRestSearchLocationErrorEventArgs

OnSearchRequestCompleted(object, DownloadStringCompletedEventArgs)

Called when the services returns response from the received BingSearchLocationRequest.

Declaration

cs-api-definition
protected virtual void OnSearchRequestCompleted(object sender, DownloadStringCompletedEventArgs e)

Parameters

sender

object

e

DownloadStringCompletedEventArgs

RegisterSetSourceCommand(MapMode, string, DataTemplate, Uri)

Registers new set source command.

Declaration

cs-api-definition
public void RegisterSetSourceCommand(MapMode imagerySet, string text, DataTemplate dataTemplate = null, Uri imageUri = null)

Parameters

imagerySet

MapMode

MapMode type.

text

string

Command text.

dataTemplate

DataTemplate

Data template for command representation.

imageUri

Uri

URI of the image is used in the map source button data template.

SearchLocationAsync(BingRestSearchLocationRequest)

Performs async search location request.

Declaration

cs-api-definition
public void SearchLocationAsync(BingRestSearchLocationRequest request)

Parameters

request

BingRestSearchLocationRequest

Search request.

Implements IBingRestSearchLocationProvider.SearchLocationAsync(BingRestSearchLocationRequest)

SetCommandState(string)

Set state of the commands depends on the new map source.

Declaration

cs-api-definition
protected override void SetCommandState(string uniqueId)

Parameters

uniqueId

string

Map source unique ID.

Overrides MapProviderBase.SetCommandState(string)

SetMapSourceToClone(MapProviderBase, string)

Set specific map source to clone of map provider.

Declaration

cs-api-definition
public override void SetMapSourceToClone(MapProviderBase clone, string uniqueId)

Parameters

clone

MapProviderBase

Clone of map provider.

uniqueId

string

Id of map source.

Overrides MapProviderBase.SetMapSourceToClone(MapProviderBase, string)

TilePresenterMapSourceChanged(object, SourceChangedEventArgs)

Called when map source is changed for tile presenter and map source initialization completed.

Declaration

cs-api-definition
protected override void TilePresenterMapSourceChanged(object sender, SourceChangedEventArgs e)

Parameters

sender

object

Sender.

e

SourceChangedEventArgs

Event parameters.

Overrides MapProviderBase.TilePresenterMapSourceChanged(object, SourceChangedEventArgs)

Events

CalculateElevationCompleted

Occurs when an elevation calculation request is completed and the result is ready.

Declaration

cs-api-definition
public event EventHandler<BingRestElevationCompletedEventArgs> CalculateElevationCompleted

Event Value

EventHandler<BingRestElevationCompletedEventArgs>

Implements IBingRestElevationProvider.CalculateElevationCompleted

CalculateElevationError

Occurs when the request results in an error.

Declaration

cs-api-definition
public event EventHandler<BingRestCalculateElevationErrorEventArgs> CalculateElevationError

Event Value

EventHandler<BingRestCalculateElevationErrorEventArgs>

Implements IBingRestElevationProvider.CalculateElevationError

CalculateRouteCompleted

Occurs when a route calculation request is completed and the result is ready.

Declaration

cs-api-definition
public event EventHandler<BingRestRoutingCompletedEventArgs> CalculateRouteCompleted

Event Value

EventHandler<BingRestRoutingCompletedEventArgs>

Implements IBingRestRouteProvider.CalculateRouteCompleted

CalculateRouteError

Occurs when the request results in an error.

Declaration

cs-api-definition
public event EventHandler<BingRestCalculateRouteErrorEventArgs> CalculateRouteError

Event Value

EventHandler<BingRestCalculateRouteErrorEventArgs>

Implements IBingRestRouteProvider.CalculateRouteError

CalculateTruckRouteCompleted

Occurs when a truck route calculation request is completed and the result is ready.

Declaration

cs-api-definition
public event EventHandler<BingRestRoutingCompletedEventArgs> CalculateTruckRouteCompleted

Event Value

EventHandler<BingRestRoutingCompletedEventArgs>

Implements IBingRestTruckRouteProvider.CalculateTruckRouteCompleted

CalculateTruckRouteError

Occurs when the request results in an error.

Declaration

cs-api-definition
public event EventHandler<BingRestCalculateRouteErrorEventArgs> CalculateTruckRouteError

Event Value

EventHandler<BingRestCalculateRouteErrorEventArgs>

Implements IBingRestTruckRouteProvider.CalculateTruckRouteError

SearchLocationCompleted

Event occurs when BingRestMapProvider completed search request.

Declaration

cs-api-definition
public event EventHandler<BingRestSearchLocationCompletedEventArgs> SearchLocationCompleted

Event Value

EventHandler<BingRestSearchLocationCompletedEventArgs>

Implements IBingRestSearchLocationProvider.SearchLocationCompleted

SearchLocationError

Occurs when the request results in an error.

Declaration

cs-api-definition
public event EventHandler<BingRestSearchLocationErrorEventArgs> SearchLocationError

Event Value

EventHandler<BingRestSearchLocationErrorEventArgs>

Implements IBingRestSearchLocationProvider.SearchLocationError

In this article
DefinitionConstructorsBingRestMapProvider()BingRestMapProvider(MapMode, BingTopLayer, string, bool)BingRestMapProvider(MapMode, bool, string)BingRestMapProvider(MapMode, bool, string, bool)BingRestMapProvider(string)FieldsIsLabelVisiblePropertyModePropertyTopLayerPropertyUseSessionPropertyPropertiesApplicationIdIsLabelVisibleModeSpatialReferenceTopLayerUseSessionMethodsApplySourceModes(string)BuildElevationRequestUri(BingRestElevationRequest)BuildRoutingRequestUri(BingRestRouteRequest)BuildSearchLocationRequestUri(BingRestSearchLocationRequest)BuildTruckRouteRequestBody(BingRestTruckRouteRequest)BuildTruckRouteVehicleSpecsBody(BingRestVehicleSpec)BuildTruckRoutingRequestUri(BingRestTruckRouteRequest)CalculateElevationAsync(BingRestElevationRequest)CalculateRouteAsync(BingRestRouteRequest)CalculateTruckRouteAsync(BingRestTruckRouteRequest)Clone()Dispose(bool)GetPointsString(List<Location>)OnCalculateElevationCompleted(BingRestElevationCompletedEventArgs)OnCalculateElevationCompleted(object, DownloadStringCompletedEventArgs)OnCalculateElevationError(BingRestCalculateElevationErrorEventArgs)OnCalculateRouteCompleted(BingRestRoutingCompletedEventArgs)OnCalculateRouteCompleted(object, DownloadStringCompletedEventArgs)OnCalculateRouteError(BingRestCalculateRouteErrorEventArgs)OnCalculateTruckRouteCompleted(BingRestRoutingCompletedEventArgs)OnCalculateTruckRouteCompleted(object, UploadStringCompletedEventArgs)OnCalculateTruckRouteError(BingRestCalculateRouteErrorEventArgs)OnPreviewSourceChange(IMapSource)OnPreviewSourceChanged(IMapSource)OnSearchLocationCompleted(BingRestSearchLocationCompletedEventArgs)OnSearchLocationError(BingRestSearchLocationErrorEventArgs)OnSearchRequestCompleted(object, DownloadStringCompletedEventArgs)RegisterSetSourceCommand(MapMode, string, DataTemplate, Uri)SearchLocationAsync(BingRestSearchLocationRequest)SetCommandState(string)SetMapSourceToClone(MapProviderBase, string)TilePresenterMapSourceChanged(object, SourceChangedEventArgs)EventsCalculateElevationCompletedCalculateElevationErrorCalculateRouteCompletedCalculateRouteErrorCalculateTruckRouteCompletedCalculateTruckRouteErrorSearchLocationCompletedSearchLocationError
Not finding the help you need?
Contact Support