BasicGoogleMaps Class

Basic Google maps control that automates databinding.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.Repeater
      CMS.Base.Web.UI.UIRepeater
        CMS.DocumentEngine.Web.UI.BasicRepeater
          CMS.DocumentEngine.Web.UI.CMSAbstractMap
            CMS.DocumentEngine.Web.UI.BasicGoogleMaps

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0

Syntax

public class BasicGoogleMaps : CMSAbstractMap

The BasicGoogleMaps type exposes the following members.

Constructors

	Name	Description
Public method	BasicGoogleMaps

Fields

	Name	Description
Protected field	mControlsLoaded	Flag saying whether the dynamic controls has been loaded yet. (Inherited from BasicRepeater.)
Protected field	mDataLoaded	Flag saying whether the data has been loaded yet. (Inherited from BasicRepeater.)
Protected field	mMapProperties	Map properties. (Inherited from CMSAbstractMap.)
Protected field	mOnBeforeInitFired	True if the on before init was fired. (Inherited from BasicRepeater.)
Protected field	mRelatedData	Custom data connected to the object. (Inherited from BasicRepeater.)
Protected field	mRelatedDataLoaded	Related data is loaded. (Inherited from BasicRepeater.)
Public field Static member	OK	Indicates that no errors occurred. The address was successfully parsed and at least one geocode was returned.
Protected field	outputHtml	Map output Html code. (Inherited from CMSAbstractMap.)
Public field Static member	OVER_QUERY_LIMIT	Indicates that you are over your quota.
Protected field	useDataSourceControl	Indicates whether the viewer should obtain data source from the referenced control provided by the value of DataSourceControl property. (Inherited from BasicRepeater.)

Properties

	Name	Description
Public property	ApiKey	API key for communicating with Google services.
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line. (Inherited from CMSAbstractMap.)
Public property	CacheItemName	Cache item name. (Inherited from CMSAbstractMap.)
Public property	CacheMinutes	Cache minutes. (Inherited from CMSAbstractMap.)
Public property	DataBindByDefault	Indicates whether data binding should be performed by default. (Inherited from BasicRepeater.)
Public property	DataSource	Object from which data-bound control retrieves its list of data item. (Inherited from BasicRepeater.)
Public property	DataSourceControl	Control with data source. (Inherited from BasicRepeater.)
Public property	DataSourceName	Gets or sets name of source. (Inherited from BasicRepeater.)
Protected property	DefaultDataSource	Default data source to use if no external is provided. (Inherited from BasicRepeater.)
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False. (Inherited from BasicRepeater.)
Public property	MainScriptPath	Map script path. (Inherited from CMSAbstractMap.)
Public property	MapProperties	Gets or sets map properties. (Inherited from CMSAbstractMap.)
Public property	PageableControl	Gets or sets the encapsulated control that implements IUniPageable interface. (Inherited from BasicRepeater.)
Public property	PagerDataItem	Pager data item object. (Inherited from BasicRepeater.)
Public property	PagerForceNumberOfResults	Gets or sets the number of result. Enables proceed "fake" datasets, where number of results in the dataset is not correspondent to the real number of results This property must be equal -1 if should be disabled (Inherited from BasicRepeater.)
Protected property Static member	ProviderObject	Provider object.
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl. (Inherited from BasicRepeater.)
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved (Inherited from BasicRepeater.)
Public property	ShortID	Short ID of the control. (Inherited from UIRepeater.)
Public property	StopProcessing	Stop control processing. (Inherited from CMSAbstractMap.)
Public property	UniPagerControl	Pager control. (Inherited from BasicRepeater.)
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows. (Inherited from BasicRepeater.)

Methods

	Name	Description
Protected method	BoundPagerToDataSource	Bound pager to the external external DataSource (Inherited from BasicRepeater.)
Protected method	CreateControlHierarchy	Creates a control hierarchy with or without the specified datasource. (Inherited from BasicRepeater.)
Public method	DataBind	Binds the data. (Inherited from BasicRepeater.)
Public method Static member	GenerateMap	Generates static map.
Public method	GetGeoCoordinates	Returns coordinates according to location address from Google service.
Public method	HasData	Indicates if datasource contains data. (Inherited from BasicRepeater.)
Protected method	InitControl	Ensures default data binding (Inherited from BasicRepeater.)
Protected method	OnInit	Init event handler. (Inherited from BasicRepeater.)
Protected method	OnItemDataBound	OnItemDataBound override. (Overrides Repeater.OnItemDataBound(RepeaterItemEventArgs).)
Protected method	OnLoad	OnLoad event handler (Inherited from BasicRepeater.)
Protected method	OnPreRender	OnPreRender override. (Overrides BasicRepeater.OnPreRender(EventArgs).)
Protected method	RaiseOnBeforeInit	Raises the OnBeforeInit event. (Inherited from BasicRepeater.)
Public method	ReBind	Evokes control databind. (Inherited from BasicRepeater.)
Public method Static member	RegisterMapScripts	Registers necessary Google javascript files.
Public method	ReloadData	Reloads the control data, skips the loading if the data is already loaded. (Inherited from BasicRepeater.)
Protected method	Render	Render override. (Overrides BasicRepeater.Render(HtmlTextWriter).)

Extension Methods

	Name	Description
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnBeforeInit	On before init handler. (Inherited from BasicRepeater.)
Public event	OnPageBinding	Occurs when the control bind data. (Inherited from BasicRepeater.)
Public event	OnPageChanged	Occurs when the pager change the page and current mode is postback => reload data (Inherited from BasicRepeater.)