TdxMapControlAzureMapInformationProvider Class
The base class for Azure Maps information providers.
#Declaration
TdxMapControlAzureMapInformationProvider = class abstract(TdxMapControlInformationProvider)
#Remarks
Information providers complement the tile data provider and allow you to display additional map-related information, such as routes and addresses.
#Azure Maps Account
To use Microsoft Azure Maps® services, you need to create an Azure Maps account and obtain a key. Assign the account key to the AzureKey property to configure the information provider.
#Main API Members
The list below outlines key members of the TdxMapControlAzureMapInformationProvider
class. These members allow you to configure the Azure map information provider.
- AzureKey
- Required. Specifies the account key required to use the Azure Maps information provider.
- CancelRequests
- Cancels pending asynchronous requests to Microsoft Azure servers.
#Code Example: Create and Configure Azure Maps Information Providers
The following code example implements a procedure that accepts an Azure Maps account key, and creates and configures all Azure Maps information provider components:
uses
dxAzureMapInformationProviders; // Declares all Azure Maps information provider classes
// ...
procedure TMyForm.CreateAzureMapsInformationProviders(const AAzureKey: string);
var
AProviders: TdxMapControlInformationProviders;
AProvider: TdxMapControlAzureMapInformationProvider;
I: Integer;
begin
AProviders := dxMapControl1.InformationProviders;
AProviders.BeginUpdate; // Initiates the following batch change
try
// Create all Azure Maps information providers
AProviders.Add(TdxMapControlAzureMapGeocodeProvider);
AProviders.Add(TdxMapControlAzureMapGeolocationProvider);
AProviders.Add(TdxMapControlAzureMapReverseGeocodeProvider);
AProviders.Add(TdxMapControlAzureMapRouteProvider);
for I := 0 to AProviders.Count - 1 do // Iterates through all created information providers
begin
AProvider := AProviders.Items[I] as TdxMapControlAzureMapInformationProvider;
AProvider.AzureKey := AAzureKey; // Assigns the same Azure Maps account key to all providers
end;
finally
AProviders.EndUpdate; // Calls EndUpdate regardless of the batch operation's success
end;
end;
#Terminal TdxMapControlAzureMapInformationProvider Class Descendants
Do not use the TdxMapControlAzureMapInformationProvider
class directly. Use the following descendants instead:
- TdxMapControlAzureMapGeocodeProvider
- An Azure Maps Geocode information provider.
- TdxMapControlAzureMapGeolocationProvider
- An Azure Maps Geolocation information provider.
- TdxMapControlAzureMapReverseGeocodeProvider
- An Azure Maps Reverse Geocode information provider.
- TdxMapControlAzureMapRouteProvider
- An Azure Maps Route information provider.
#Related Compiled Demo
To see Microsoft Azure Map tile and information providers in action, run the Mapping demo in the VCL Demo Center installed with compiled DevExpress demos. When the demo is opened, it downloads tile data and additional information from Azure Map servers to display a map and build routes between specified points.
Tip
Compiled DevExpress demos ship with source code installed in the Public Documents folder (%Public%) for all users (default). You can find all project and source code files for the Map Control demo in the following folder:
%Public%\Documents\DevExpress VCL Demos\Mega