Class

BingRestMapProvider

Initializes a new instance of the BingRestMapProvider class with default settings and configures tile downloading and caching.

Declaration

public BingRestMapProvider()

Declaration

protected Dictionary<string, List<TileInfo>> cacheLoadReference

Field Value

Declaration

protected object lockObj

Field Value

Declaration

protected Dictionary<string, TileInfo> tileMatrix

Field Value

Gets or sets the Bing Maps API key used for authenticating requests to Bing Maps services and enabling premium features.

Declaration

public string BingKey { get; set; }

Property Value

Gets or sets the cache provider instance used for storing and retrieving map tiles from local storage.

Declaration

public IMapCacheProvider CacheProvider { get; set; }

Property Value

Implements IMapTileProvider.CacheProvider

Gets or sets the culture information used for localizing map content, search results, and routing instructions.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Gets or sets a value indicating whether tile caching is enabled for storing downloaded tiles locally to improve performance.

Declaration

public bool EnableCaching { get; set; }

Property Value

Implements IMapTileProvider.EnableCaching

Gets the unique identifier for this Bing Maps provider instance.

Declaration

public string Id { get; }

Property Value

Implements IMapProvider.Id

Gets or sets the Bing Maps imagery set that determines the visual style and content type of map tiles displayed.

Declaration

public ImagerySet ImagerySet { get; set; }

Property Value

Gets or sets a value indicating whether this BingRestMapProvider has completed initialization and is ready for service calls.

Declaration

public bool Initialized { get; protected set; }

Property Value

Gets or sets a value indicating whether this BingRestMapProvider is currently performing initialization operations.

Declaration

public bool Initializing { get; protected set; }

Property Value

Gets or sets the maximum zoom level supported by this Bing Maps provider for tile requests and map display.

Declaration

public int MaxZoomLevel { get; set; }

Property Value

Implements IMapProvider.MaxZoomLevel

Gets or sets the minimum zoom level supported by this Bing Maps provider for tile requests and map display.

Declaration

public int MinZoomLevel { get; set; }

Property Value

Implements IMapProvider.MinZoomLevel

Gets the unique session identifier obtained from Bing Maps logging service for optimized API usage and cost reduction.

Declaration

public string SessionId { get; }

Property Value

Gets the settings that control tile rendering behavior.

Declaration

public MapTileProviderSettings Settings { get; }

Property Value

Implements IMapTileProvider.Settings

Gets or sets the tile downloader instance responsible for asynchronously downloading map tiles from Bing Maps service.

Declaration

public IMapTileDownloader TileDownloader { get; set; }

Property Value

Implements IMapTileProvider.TileDownloader

Gets the standard tile size in pixels used by this Bing Maps provider for all tile requests and rendering operations.

Declaration

public Size TileSize { get; }

Property Value

Implements IMapTileProvider.TileSize

Gets or sets a value indicating whether to use session-based authentication for improved performance and reduced transaction costs.

Declaration

public bool UseSession { get; set; }

Property Value

Constructs the Bing Maps elevation request URI based on the elevation request parameters and elevation type settings.

Declaration

protected virtual Uri BuildElevationRequestUri(ElevationRequest request)

Parameters

Returns

Constructs the Bing Maps routing request URI based on the route request parameters and travel mode settings.

Declaration

protected virtual Uri BuildRoutingRequestUri(RouteRequest request)

Parameters

Returns

Constructs the Bing Maps search request URI based on the search request parameters and localization settings.

Declaration

protected virtual Uri BuildSearchRequestUri(SearchRequest request)

Parameters

Returns

Constructs the JSON request body for truck routing containing waypoints, vehicle specifications, and routing options.

Declaration

protected virtual string BuildTruckRouteRequestBody(TruckRouteRequest request)

Parameters

Returns

Constructs the Bing Maps truck routing request URI with authentication parameters for the truck routing service.

Declaration

protected virtual Uri BuildTruckRouteRequestUri(TruckRouteRequest request)

Parameters

Returns

Performs an asynchronous elevation calculation using Bing Maps elevation services with the specified elevation request parameters.

Declaration

public void CalculateElevationAsync(ElevationRequest request)

Parameters

Implements IMapElevationProvider.CalculateElevationAsync(ElevationRequest)

Performs an asynchronous route calculation using Bing Maps routing services with the specified route request parameters.

Declaration

public void CalculateRouteAsync(RouteRequest request)

Parameters

Implements IMapRouteProvider.CalculateRouteAsync(RouteRequest)

Performs an asynchronous truck route calculation using Bing Maps truck routing services with vehicle specifications and restrictions.

Declaration

public void CalculateTruckRouteAsync(TruckRouteRequest request)

Parameters

Implements IMapTruckRouteProvider.CalculateTruckRouteAsync(TruckRouteRequest)

Creates a deep copy of this BingRestMapProvider instance with all configuration settings and metadata information.

Declaration

public object Clone()

Returns

Implements ICloneable.Clone()

Generates a unique cache key string for storing and retrieving tile images based on coordinates, zoom level, and imagery set.

Declaration

protected virtual string GetCacheKey(int tileX, int tileY, int zoomLevel)

Parameters

Returns

Generates map visual elements for the specified viewport by converting cached tile images into renderable map tile elements.

Declaration

public virtual IEnumerable<MapVisualElement> GetContent(IMapViewport viewport)

Parameters

Returns

Implements IMapProvider.GetContent(IMapViewport)

Converts a list of geographic points into a comma-separated string format for use in elevation API requests.

Declaration

protected virtual string GetPointsString(List<PointG> points)

Parameters

Returns

Retrieves a list of supported map views based on available Bing Maps imagery sets with localized names and selection state.

Declaration

public virtual List<MapViewInfo> GetSupportedViews()

Returns

Implements IMapProvider.GetSupportedViews()

Constructs the URI for retrieving a specific map tile from Bing Maps service using tile matrix coordinates and zoom level.

Declaration

public Uri GetTile(int tileMatrixX, int tileMatrixY, int zoomLevel)

Parameters

Returns

Synchronously retrieves a tile image from Bing Maps service or cache using the specified tile matrix coordinates and zoom level.

Declaration

public Image GetTileImage(int tileMatrixX, int tileMatrixY, int zoomLevel)

Parameters

Returns

Implements IMapTileProvider.GetTileImage(int, int, int)

Retrieves the tile image for the specified TileInfo either from cache or by downloading from Bing Maps service.

Declaration

protected virtual void GetTileInfoImage(TileInfo tileInfo)

Parameters

Initializes this Bing Maps provider by establishing session authentication and retrieving imagery metadata for tile operations.

Declaration

public virtual void Initialize()

Exceptions

Implements IMapProvider.Initialize()

Handles the completion of imagery metadata initialization by processing service response and configuring tile size and zoom levels.

Declaration

protected virtual void InitializeImageryMetadataCompleted(object sender, DownloadStringCompletedEventArgs e)

Parameters

Initializes the Bing Maps imagery service by retrieving metadata information for the current imagery set and configuring tile parameters.

Declaration

protected virtual void InitializeImageryService()

Exceptions

Handles the completion of session initialization by extracting the session ID and proceeding to initialize imagery services.

Declaration

protected virtual void InitializeSessionCompleted(object sender, DownloadStringCompletedEventArgs e)

Parameters

Raises the CalculateElevationCompleted event to notify subscribers that an elevation calculation has finished successfully.

Declaration

protected virtual void OnCalculateElevationCompleted(ElevationCompletedEventArgs e)

Parameters

Handles the completion of elevation calculation by processing the JSON response and extracting elevation or sea level data.

Declaration

protected virtual void OnCalculateElevationCompleted(object sender, DownloadStringCompletedEventArgs e)

Parameters

Raises the CalculateElevationError event to notify subscribers that an elevation calculation has encountered an error.

Declaration

protected virtual void OnCalculateElevationError(CalculateElevationErrorEventArgs e)

Parameters

Raises the CalculateRouteCompleted event to notify subscribers that a route calculation has finished successfully.

Declaration

protected virtual void OnCalculateRouteCompleted(RoutingCompletedEventArgs e)

Parameters

Handles the completion of route calculation by processing the JSON response and extracting route information.

Declaration

protected virtual void OnCalculateRouteCompleted(object sender, DownloadStringCompletedEventArgs e)

Parameters

Raises the CalculateRouteError event to notify subscribers that a route calculation has encountered an error.

Declaration

protected virtual void OnCalculateRouteError(CalculateRouteErrorEventArgs e)

Parameters

Raises the CalculateTruckRouteCompleted event to notify subscribers that a truck route calculation has finished successfully.

Declaration

protected virtual void OnCalculateTruckRouteCompleted(RoutingCompletedEventArgs e)

Parameters

Handles the completion of truck route calculation by processing the JSON response and extracting truck route information.

Declaration

protected virtual void OnCalculateTruckRouteCompleted(object sender, UploadStringCompletedEventArgs e)

Parameters

Raises the CalculateTruckRouteError event to notify subscribers that a truck route calculation has encountered an error.

Declaration

protected virtual void OnCalculateTruckRouteError(CalculateRouteErrorEventArgs e)

Parameters

Handles the completion of asynchronous file loading from cache and initiates tile download if cache content is unavailable.

Declaration

protected virtual void OnFileLoadAsyncComplete(string fileName, byte[] content)

Parameters

Raises the InitializationComplete event to notify subscribers that provider initialization has finished.

Declaration

protected virtual void OnInitializationComplete(EventArgs e)

Parameters

Raises the InitializationError event to notify subscribers that provider initialization has failed.

Declaration

protected virtual void OnInitializationError(InitializationErrorEventArgs e)

Parameters

Raises the ProviderUpdated event to notify subscribers that provider content has changed.

Declaration

protected virtual void OnProviderUpdated(EventArgs e)

Parameters

Raises the SearchCompleted event to notify subscribers that a search operation has finished successfully.

Declaration

protected virtual void OnSearchCompleted(SearchCompletedEventArgs e)

Parameters

Raises the SearchError event to notify subscribers that a search operation has encountered an error.

Declaration

protected virtual void OnSearchError(SearchErrorEventArgs e)

Parameters

Handles the completion of search requests by processing the JSON response and extracting location information using multiple encoding strategies.

Declaration

protected virtual void OnSearchRequestCompleted(object sender, DownloadStringCompletedEventArgs e)

Parameters

Handles tile download completion events, manages cache storage, and updates wraparound tiles with downloaded content.

Declaration

protected virtual void OnTileDownloadComplete(object sender, TileInfoEventArgs e)

Parameters

Performs an asynchronous search operation using Bing Maps search services with the specified search request parameters.

Declaration

public void SearchAsync(SearchRequest request)

Parameters

Implements IMapSearchProvider.SearchAsync(SearchRequest)

Sets the active map view by configuring the imagery set based on the specified view information and label settings.

Declaration

public virtual void SetView(MapViewInfo view)

Parameters

Implements IMapProvider.SetView(MapViewInfo)

Responds to viewport changes by calculating visible tiles, managing tile downloads, and updating the tile matrix for rendering.

Declaration

public void ViewportChanged(IMapViewport viewport, ViewportChangeAction action)

Parameters

Implements IMapProvider.ViewportChanged(IMapViewport, ViewportChangeAction)

Occurs when an elevation calculation operation has completed successfully with elevation results.

Declaration

public event EventHandler<ElevationCompletedEventArgs> CalculateElevationCompleted

Event Value

Implements IMapElevationProvider.CalculateElevationCompleted

Occurs when an elevation calculation operation encounters an error during execution.

Declaration

public event EventHandler<CalculateElevationErrorEventArgs> CalculateElevationError

Event Value

Implements IMapElevationProvider.CalculateElevationError

Occurs when a route calculation operation has completed successfully with routing results.

Declaration

public event EventHandler<RoutingCompletedEventArgs> CalculateRouteCompleted

Event Value

Implements IMapRouteProvider.CalculateRouteCompleted

Occurs when a route calculation operation encounters an error during execution.

Declaration

public event EventHandler<CalculateRouteErrorEventArgs> CalculateRouteError

Event Value

Implements IMapRouteProvider.CalculateRouteError

Occurs when a truck route calculation operation has completed successfully with truck routing results.

Declaration

public event EventHandler<RoutingCompletedEventArgs> CalculateTruckRouteCompleted

Event Value

Implements IMapTruckRouteProvider.CalculateTruckRouteCompleted

Occurs when a truck route calculation operation encounters an error during execution.

Declaration

public event EventHandler<CalculateRouteErrorEventArgs> CalculateTruckRouteError

Event Value

Implements IMapTruckRouteProvider.CalculateTruckRouteError

Occurs when the Bing Maps provider has completed its initialization process and is ready for use.

Declaration

public event EventHandler InitializationComplete

Event Value

Implements IMapProvider.InitializationComplete

Occurs when provider initialization encounters an error during setup.

Declaration

public event InitializationErrorEventHandler InitializationError

Event Value

Implements IMapProvider.InitializationError

Occurs when the provider content has been updated with new tile data or configuration changes.

Declaration

public event EventHandler ProviderUpdated

Event Value

Implements IMapProvider.ProviderUpdated

Occurs when a search operation has completed successfully with search results.

Declaration

public event EventHandler<SearchCompletedEventArgs> SearchCompleted

Event Value

Implements IMapSearchProvider.SearchCompleted

Occurs when a search operation encounters an error during execution.

Declaration

public event EventHandler<SearchErrorEventArgs> SearchError

Event Value

Implements IMapSearchProvider.SearchError