ClassMapProviderBase
Base class for all map providers. Every map provider can use 1 type of the tile sources. I.e. TiledProvider can use TiledMapSources only and ImageProvider can use ImageMapSource only.
Definition
Namespace:Telerik.Windows.Controls.Map
Assembly:Telerik.Windows.Controls.DataVisualization.dll
Syntax:
public class MapProviderBase : Freezable, IDisposableInheritance: objectMapProviderBase
Derived Classes:
Implements:
Constructors
MapProviderBase()
Initializes a new instance of the MapProviderBase class.
Declaration
protected MapProviderBase()Fields
GeoBoundsNWProperty
Identifies the GeoBoundsNW GeoBoundsNW dependency property.
Declaration
public static readonly DependencyProperty GeoBoundsNWPropertyField Value
DependencyProperty
GeoBoundsProperty
Identifies the GeoBounds GeoBounds dependency property.
Declaration
public static readonly DependencyProperty GeoBoundsPropertyField Value
DependencyProperty
GeoBoundsSEProperty
Identifies the GeoBoundsSE GeoBoundsSE dependency property.
Declaration
public static readonly DependencyProperty GeoBoundsSEPropertyField Value
DependencyProperty
OpacityProperty
Identifies the Opacity Opacity dependency property.
Declaration
public static readonly DependencyProperty OpacityPropertyField Value
DependencyProperty
Properties
CommandBindingCollection
Gets collection of the command bindings.
Declaration
public CommandBindingCollection CommandBindingCollection { get; }Property Value
CommandBindingCollection
Commands
Gets collection of the commands supported by provider.
Declaration
public ObservableCollection<CommandDescription> Commands { get; }Property Value
GeoBounds
Gets or sets region covered by map image.
Declaration
public LocationRect GeoBounds { get; set; }Property Value
Remarks
You can't use this property to set bounds at the same time with GeoBoundsNW and GeoBoundsSE properties.
GeoBoundsNW
Gets or sets north-west corner of the region covered by map image.
Declaration
public Location GeoBoundsNW { get; set; }Property Value
Remarks
You can't use this property to set bounds at the same time with GeoBounds property.
GeoBoundsSE
Gets or sets south-east corner of the region covered by map image.
Declaration
public Location GeoBoundsSE { get; set; }Property Value
Remarks
You can't use this property to set bounds at the same time with GeoBounds property.
MapSources
Gets dictionary of the available map sources.
Declaration
protected Dictionary<string, IMapSource> MapSources { get; }Property Value
Opacity
Gets or sets the opacity factor.
SpatialReference
Gets spatial reference of the current map source.
Declaration
public virtual ISpatialReference SpatialReference { get; }Property Value
SupportedSources
Gets ids of the supported sources.
Methods
ApplySourceModes(string)
Apply map source modes.
Declaration
protected virtual string ApplySourceModes(string uniqueId)Parameters
uniqueId
Base source unique ID.
Returns
Unique ID of the map source with applied modes.
Remarks
Some providers can have different modes for the same base source. This method allows apply this kind of modes to the base source.
CreateInstanceCore()
When implemented in a derived class, creates a new instance of the Freezable derived class.
Declaration
protected override Freezable CreateInstanceCore()Returns
Freezable
The new instance.
Dispose()
Releases the resources used by the current instance of the MapProviderBase class.
Declaration
public void Dispose()Implements
Dispose(bool)
Called by the Dispose() and Finalize() methods to release the unmanaged resources used by the current instance of the MapProviderBase class.
Declaration
protected virtual void Dispose(bool disposing)Parameters
disposing
True to release unmanaged and managed resources; false to release only unmanaged resources.
GetValidatedGeoPoint(Location)
Gets the closest valid geographical point for the one supplied (longitude, latitude).
InheritCurrentSource(MapProviderBase)
Sets current map source to cloned provider.
Declaration
protected virtual void InheritCurrentSource(MapProviderBase clone)Parameters
clone
Clone of tiled provider.
InheritParameters(MapProviderBase)
Sets necessary properties to cloned provider.
Declaration
protected virtual void InheritParameters(MapProviderBase clone)Parameters
clone
Clone of tiled provider.
OnPreviewSourceChange(IMapSource)
Called before map provider switch to another map source.
Declaration
protected virtual bool OnPreviewSourceChange(IMapSource source)Parameters
source
Map source which will be used.
Returns
OnPreviewSourceChanged(IMapSource)
Called after map provider switch to another map source.
Declaration
protected virtual void OnPreviewSourceChanged(IMapSource source)Parameters
source
Map source is used.
RegisterSetSourceCommand(Type, string, DataTemplate, Uri, CanExecuteRoutedEventHandler, ExecutedRoutedEventHandler)
Register new set source command.
Declaration
protected void RegisterSetSourceCommand(Type sourceType, string text, DataTemplate dataTemplate, Uri imageUri, CanExecuteRoutedEventHandler canExecute, ExecutedRoutedEventHandler execute)Parameters
sourceType
Map source type.
text
Command text.
dataTemplate
DataTemplate
Data template for command representation.
imageUri
Uri
URI of the image is used in the map source button data template.
canExecute
CanExecuteRoutedEventHandler
Can execute handler.
execute
ExecutedRoutedEventHandler
Execute handler.
SetCommandState(string)
Set state of the commands depends on the new map source.
Declaration
protected virtual void SetCommandState(string uniqueId)Parameters
uniqueId
Map source unique ID.
SetMapSource(string)
Force map provider to use specific map source.
Declaration
public void SetMapSource(string uniqueId)Parameters
uniqueId
Unique ID of the map source.
SetMapSourceToClone(MapProviderBase, string)
Set specific map source to clone of map provider.
Declaration
public virtual void SetMapSourceToClone(MapProviderBase clone, string uniqueId)Parameters
clone
Clone of map provider.
uniqueId
Id of map source.
SourceInitializationFaulted(object, InitializationFaultEventArgs)
Called when map source initialization faulted.
Declaration
protected void SourceInitializationFaulted(object sender, InitializationFaultEventArgs e)Parameters
sender
Sender.
e
Event parameters.
TilePresenterMapSourceChanged(object, SourceChangedEventArgs)
Called when map source is changed for tile presenter and map source initialization completed.
Declaration
protected virtual void TilePresenterMapSourceChanged(object sender, SourceChangedEventArgs e)Parameters
sender
Sender.
e
Event parameters.
TryGetMapSource(string, out IMapSource)
Attempts to get a map source from the registered map sources by provided source Id.
Declaration
public bool TryGetMapSource(string uniqueId, out IMapSource source)Parameters
uniqueId
The id of the map source.
source
The result map source.
Returns
Events
InitializationFaulted
Occurs when initialization of the one of the map sources is faulted.
Declaration
public event EventHandler<InitializationFaultEventArgs> InitializationFaultedEvent Value
MapSourceChanged
Event occurs when map source is actually changed.
Declaration
public event EventHandler<MapSourceChangedEventArgs> MapSourceChangedEvent Value
SpatialReferenceChanged
Event occurs when spatial reference is ready to use.
Declaration
public event EventHandler SpatialReferenceChangedEvent Value