====== ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay ======

{{section>upgrade_map_suite_to_10.0}}

Represents an overlay object that gets map images from the WMS servers.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.WebEdition.Overlay
      ***ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay() **

  * //Initialize an instance of the WmsOverlay class.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28.29//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String) **

  * //Initialize an instance of the WmsOverlay class with the overlay identifier specified.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.29//
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier string used to find the overlay.

<div newline></div>
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(WorldMapKitLayerType) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28WorldMapKitLayerType.29//
== Parameters ==
  * //layerType//
    * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String,WorldMapKitLayerType) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.2C_WorldMapKitLayerType.29//
== Parameters ==
  * //id//
    * Type:String
    * Description:N/A

  * //layerType//
    * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String,TileType) **

  * //Initialize an instance of the WmsOverlay class with the overlay identifier specified.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.2C_TileType.29//
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier string used to find the overlay.

  * //tileType//
    * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]]
    * Description:Whether or not the overlay uses tiling.

<div newline></div>
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsWebOverlay(String,TileType,WorldMapKitLayerType) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.2C_TileType.2C_WorldMapKitLayerType.29//
== Parameters ==
  * //id//
    * Type:String
    * Description:N/A

  * //tileType//
    * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]]
    * Description:N/A

  * //layerType//
    * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]
    * Description:N/A

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} ToJson() **

  * //Returns a JSON string which contains the information for creating an overlay at the client side.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#ToJson.28.29//

== Return Value ==
  * Type:String
  * Description:A JSON string which is used to create an overlay at the client side.

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#ToString.28.29//

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#Equals.28Object.29//

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#GetHashCode.28.29//

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#GetType.28.29//

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //page//
    * Type:Page
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) **

  * //Registers a Javascript library URL string to the client HTML page.//
== Remarks ==
  * //The <strong>RegisterJavaScriptLibraryCore</strong> method allows derived classes to override and register their own Javascript library URL to the HTML page.//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //page//
    * Type:Page
    * Description:The page object that is used for registering the javascript library.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:EventArgs
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) **

  * //Raises the Tick event of the MarkerOverlay.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#OnTick.28EventArgs.29//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:EventArgs
    * Description:An System.EventArgs object that contains the event data.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Finalize() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#Finalize.28.29//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#MemberwiseClone.28.29//

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} Projection **

Gets or sets a WorldMapKitProjection represents which projection will be used.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#Projection
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]]

** {{wiki:PublicProperty.gif|}} LayerType **

N/A
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28WorldMapKitLayerType.29
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]

** {{wiki:PublicProperty.gif|}} MapType **

N/A
== Remarks ==
For the most updated Info for this topic, please check it here:
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitMapType|WorldMapKitMapType]]

** {{wiki:PublicProperty.gif|}} TransitionEffect **

Gets or sets the transition effect to use when the map is zoomed.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#TransitionEffect
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]]

** {{wiki:PublicProperty.gif|}} TransitionEffectDelayInMilliseconds **

N/A
== Remarks ==
For the most updated Info for this topic, please check it here:
== Return Value ==
  * Type:Int32

** {{wiki:PublicProperty.gif|}} TileType **

Gets or sets whether or not the WmsOverlay uses tiling.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#WorldMapKitWmsWebOverlay.28String.2C_TileType.29
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]]

** {{wiki:PublicProperty.gif|}} WrapDateline **

Gets or sets a value that indicates whether the overlay wraps at the date line.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#WrapDateline
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.WrapDatelineMode|WrapDatelineMode]]

** {{wiki:PublicProperty.gif|}} IsVisible **

Gets or sets a value that indicates whether the overlay is visible on the map.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#IsVisible
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} Name **

Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#Name
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} Opacity **

Gets or sets the opacity level of the overlay.
== Remarks ==
The <strong>Opacity</strong> property enables you to specify a level of transparency for the overlay. When this property is set to a value less than 100 percent (1.00), the entire overlay is made more transparent. The lower the value, the more transparent it is. Setting this property to a value of 0 percent (0.00) makes the overlay completely invisible.
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher **

Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#IsVisibleInOverlaySwitcher
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} IsBaseOverlay **

Gets or sets a value that indicates whether the overlay is a base overlay.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#IsBaseOverlay
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} Id **

Gets the identifier for the overlay to be found.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#Id
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} AutoRefreshInterval **

Gets or sets the time interval in which the MarkerOverlay refreshes itself.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#AutoRefreshInterval
== Return Value ==
  * Type:TimeSpan

** {{wiki:PublicProperty.gif|}} Attribution **

N/A
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#Attribution
== Return Value ==
  * Type:String

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} /hM= **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Dictionary<String,String>

** {{wiki:ProtectedProperty.gif|}} ARQ= **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Int32

** {{wiki:ProtectedProperty.gif|}} BBQ= **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Int32

** {{wiki:ProtectedProperty.gif|}} BxQ= **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WebEdition.WebImageFormat|WebImageFormat]]

** {{wiki:ProtectedProperty.gif|}} OverlayType **

Gets a string that indicates the overlay type.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#OverlayType
== Return Value ==
  * Type:String

** {{wiki:ProtectedProperty.gif|}} CRQ= **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Collection<Uri>

** {{wiki:ProtectedProperty.gif|}} HasTickEvent **

Don't support auto tick event by default.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#HasTickEvent
== Return Value ==
  * Type:Boolean

** {{wiki:ProtectedProperty.gif|}} 3hM= **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Double

==== Public Events ====
** {{wiki:PublicEvent.gif|}} Tick **
Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.
== Remarks ==
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.WorldMapKitWmsWebOverlay#OnTick.28EventArgs.29

Event Arguments:EventArgs