C# Class Engage.Dnn.Locator.Maps.MapProvider

An abstract base class for map providers, including the ability to display maps in HTML and JavaScript, and the ability to geocode locations.

Public Methods

Method	Description
CreateInstance ( MapProviderType providerType, string apiKey ) : MapProvider	Creates a concrete instance of a MapProvider with the given providerType.
CreateInstance ( string className, string apiKey ) : MapProvider	Creates a concrete instance of a MapProvider with the given className.
GenerateMapScriptCore ( ScriptManager scriptManager, MapType mapType, string mapSectionId, string currentLocationSpanId, string noLocationSpanId, string instructionSpanId, string directionsLinkId, string directionsSectionId, LocationCollection locations, bool showAllLocationsOnLoad ) : void	Registers the JavaScript to display the map.
GeocodeLocation ( string street, string city, int regionId, string zip, int countryId ) : GeocodeResult	Gets the latitude and longitude of the given location.
IsKeyValid ( ) : bool	Determines whether this provider's is in a valid format.
RegisterMapScript ( ScriptManager scriptManager, MapType mapType, string mapSectionId, string currentLocationSpanId, string noLocationSpanId, string instructionSpanId, string directionsLinkId, string directionsSectionId, LocationCollection locations, bool showAllLocationsOnLoad ) : void	Registers the JavaScript to display the map.

Method	Description
GetElementJavaScript ( string elementId ) : string	Returns the JavaScript to select the element with the given ID.
GetRegionAbbreviation ( int regionId ) : string	Gets the abbreviation for the region with the given ID.

Creates a concrete instance of a MapProvider with the given providerType.

public static CreateInstance ( MapProviderType providerType, string apiKey ) : MapProvider
providerType	MapProviderType	Type of the map provider.
apiKey	string	The API key for this provider.
return	MapProvider

Creates a concrete instance of a MapProvider with the given className.

public static CreateInstance ( string className, string apiKey ) : MapProvider
className	string	The fully qualified name of the type to instantiate.
apiKey	string	The API key for this provider.
return	MapProvider

Registers the JavaScript to display the map.

public abstract GenerateMapScriptCore ( ScriptManager scriptManager, MapType mapType, string mapSectionId, string currentLocationSpanId, string noLocationSpanId, string instructionSpanId, string directionsLinkId, string directionsSectionId, LocationCollection locations, bool showAllLocationsOnLoad ) : void
scriptManager	ScriptManager	The page's script manager.
mapType	MapType	Type of the map.
mapSectionId	string	The ID of the section (div) on the page in which the map should be created.
currentLocationSpanId	string	The ID of the span showing the current location text.
noLocationSpanId	string	The ID of the span shown when no location is selected.
instructionSpanId	string	The ID of the span with driving directions, etc.
directionsLinkId	string	The ID of the link to driving directions.
directionsSectionId	string	The ID of the section (div) with driving directions text.
locations	LocationCollection	The list of locations to display.
showAllLocationsOnLoad	bool	if set to true shows the map with all locations on it by default.
return	void

Gets the latitude and longitude of the given location.

public abstract GeocodeLocation ( string street, string city, int regionId, string zip, int countryId ) : GeocodeResult
street	string	The street of the address.
city	string	The city of the address.
regionId	int	The ID of the region of the address.
zip	string	The zip code of the address.
countryId	int	The ID of the country of the address
return	GeocodeResult

Returns the JavaScript to select the element with the given ID.

protected static GetElementJavaScript ( string elementId ) : string
elementId	string	The ID of the element to get.
return	string

Gets the abbreviation for the region with the given ID.

protected static GetRegionAbbreviation ( int regionId ) : string
regionId	int	The region id.
return	string

Determines whether this provider's is in a valid format.

public abstract IsKeyValid ( ) : bool
return	bool

Registers the JavaScript to display the map.

public RegisterMapScript ( ScriptManager scriptManager, MapType mapType, string mapSectionId, string currentLocationSpanId, string noLocationSpanId, string instructionSpanId, string directionsLinkId, string directionsSectionId, LocationCollection locations, bool showAllLocationsOnLoad ) : void
scriptManager	ScriptManager	The page's script manager.
mapType	MapType	Type of the map.
mapSectionId	string	The ID of the section (div) on the page in which the map should be created.
currentLocationSpanId	string	The ID of the span showing the current location text.
noLocationSpanId	string	The ID of the span shown when no location is selected.
instructionSpanId	string	The ID of the span with driving directions, etc.
directionsLinkId	string	The ID of the link to driving directions.
directionsSectionId	string	The ID of the section (div) with driving directions text.
locations	LocationCollection	The list of locations to display.
showAllLocationsOnLoad	bool	if set to true shows the map with all locations on it by default.
return	void