====== ThinkGeo.MapSuite.SilverlightEdition.WmsOverlay ======

{{section>upgrade_map_suite_to_10.0}}

Represents an overlay object that gets map images from the WMS server you specify.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.SilverlightEdition.Overlay
      ***ThinkGeo.MapSuite.SilverlightEdition.WmsOverlay**
        *[[ThinkGeo.MapSuite.SilverlightEdition.GoogleOverlay]]
        *[[ThinkGeo.MapSuite.SilverlightEdition.ServerLayerOverlay]]
        *[[ThinkGeo.MapSuite.SilverlightEdition.TiledWmsOverlay]]
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} WmsOverlay() **

  * //This is constructor of WmsOverlay class.//
== Remarks ==
  * //This is constructor of WmsOverlay class.//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} WmsOverlay(String) **

  * //This is constructor of WmsOverlay class.//
== Remarks ==
  * //This is constructor of WmsOverlay class.//
== Parameters ==
  * //name//
    * Type:String
    * Description:A string value indicating the name of this overlay.

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

  * //This is constructor of WmsOverlay class.//
== Remarks ==
  * //This is constructor of WmsOverlay class.//
== Parameters ==
  * //name//
    * Type:String
    * Description:A string value indicating the name of this overlay.

  * //serverUri//
    * Type:Uri
    * Description:A Uri value indicating the Wms server address.

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

  * //This is constructor of WmsOverlay class.//
== Remarks ==
  * //This is constructor of WmsOverlay class.//
== Parameters ==
  * //name//
    * Type:String
    * Description:A string value indicating the name of this overlay.

  * //serverUri//
    * Type:Uri
    * Description:A Uri value indicating the Wms server address.

  * //tileType//
    * Type:[[ThinkGeo.MapSuite.SilverlightEdition.TileType|TileType]]
    * Description:This enumeration specifies whether the overlay uses tiling.

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

  * //This is constructor of WmsOverlay class.//
== Remarks ==
  * //This is constructor of WmsOverlay class.//
== Parameters ==
  * //name//
    * Type:String
    * Description:A string value indicating the name of this overlay.

  * //serverUris//
    * Type:IEnumerable<Uri>
    * Description:This parameter indicates a collection of uris for the Wms server.

  * //tileType//
    * Type:[[ThinkGeo.MapSuite.SilverlightEdition.TileType|TileType]]
    * Description:This enumeration specifies whether the overlay uses tiling.

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

  * //This method initializes the overlay canvas such as width, height and z-index for first time.//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //currentMap//
    * Type:[[ThinkGeo.MapSuite.SilverlightEdition.Map|Map]]
    * Description:N/A

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

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

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

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(RectangleShape,OverlayDrawType) **

  * //This method draws the features in the specified extent.//
== Remarks ==
  * //This method draws the features in the specified extent.//

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

== Parameters ==
  * //worldExtent//
    * Type:[[ThinkGeo.MapSuite.SilverlightCore.RectangleShape|RectangleShape]]
    * Description:The new world extent of the map.

  * //overlayDrawType//
    * Type:[[ThinkGeo.MapSuite.SilverlightEdition.OverlayDrawType|OverlayDrawType]]
    * Description:The enum value indecating that the map draws features or not.

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

  * //This API gets the GetCapabilites document of the service.//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:This API returns the GetCapabilites document of the service.

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

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

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
  * Description:N/A

== Parameters ==
  * //screenX//
    * Type:Double
    * Description:N/A

  * //screenY//
    * Type:Double
    * Description:N/A

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

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

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
  * Description:N/A

== Parameters ==
  * //screenCoordinate//
    * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
    * Description:N/A

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

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

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
  * Description:N/A

== Parameters ==
  * //screenCoordinate//
    * Type:Point
    * Description:N/A

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

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

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
  * Description:N/A

== Parameters ==
  * //worldX//
    * Type:Double
    * Description:N/A

  * //worldY//
    * Type:Double
    * Description:N/A

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

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

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
  * Description:N/A

== Parameters ==
  * //worldCoordinate//
    * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
    * Description:N/A

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

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

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
  * Description:N/A

== Parameters ==
  * //worldCoordinate//
    * Type:Point
    * Description:N/A

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  * //This method initializes the overlay canvas such as width, height and z-index for first time.//
== Remarks ==
  * //This method initializes the overlay canvas such as width, height and z-index for first time.//

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

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

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

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

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.SilverlightEdition.GetServerCapabilitiesXmlCompletedWmsOverlayEventArgs|GetServerCapabilitiesXmlCompletedWmsOverlayEventArgs]]
    * Description:N/A

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

  * //This method raised when zooming animation plays completed.//
== Remarks ==
  * //N/A//

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

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

  * //This method draws the features in the specified extent.//
== Remarks ==
  * //This method draws the features in the specified extent.//

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

== Parameters ==
  * //worldExtent//
    * Type:[[ThinkGeo.MapSuite.SilverlightCore.RectangleShape|RectangleShape]]
    * Description:A RectangleShape value indicating the world extent need to draw.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} GetTileUri(Uri,RectangleShape,Int32,Int32,Int32,Int32,Double) **

  * //This method gets the uri address which uses for requesting images from Wms server.//
== Remarks ==
  * //This method gets the uri address which uses for requesting images from Wms server.//

== Return Value ==
  * Type:Uri
  * Description:An uri address which uses for requesting images from Wms server.

== Parameters ==
  * //serverUri//
    * Type:Uri
    * Description:An Uri value indicating the Wms server address.

  * //tileExtent//
    * Type:[[ThinkGeo.MapSuite.SilverlightCore.RectangleShape|RectangleShape]]
    * Description:A RectangleShape value indicating the tile extent which uses for requesting images from wms server.

  * //row//
    * Type:Int32
    * Description:An integar value indicating the row index of the tile in the world extent.

  * //column//
    * Type:Int32
    * Description:An integar value indicating the row index of the tile in the world extent.

  * //tileWidth//
    * Type:Int32
    * Description:A double value indicating the width in pixel of the tile.

  * //tileHeight//
    * Type:Int32
    * Description:A double value indicating the height in pixel of the tile.

  * //scale//
    * Type:Double
    * Description:A double value indicating current scale of the requesting tile.

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

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

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

== Parameters ==
  * //extent//
    * Type:[[ThinkGeo.MapSuite.SilverlightCore.RectangleShape|RectangleShape]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MBU=(Image,RectangleShape) **

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

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

== Parameters ==
  * //image//
    * Type:Image
    * Description:N/A

  * //currentExtent//
    * Type:[[ThinkGeo.MapSuite.SilverlightCore.RectangleShape|RectangleShape]]
    * Description:N/A

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

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

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

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.SilverlightCore.GeoCanvas|GeoCanvas]]
    * Description:N/A

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

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

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

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.SilverlightCore.GeoCanvas|GeoCanvas]]
    * Description:N/A

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

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

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

== Parameters ==
  * //args//
    * Type:[[ThinkGeo.MapSuite.SilverlightEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
    * Description:N/A

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

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

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

== Parameters ==
  * //args//
    * Type:[[ThinkGeo.MapSuite.SilverlightEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
    * Description:N/A

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

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

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

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

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

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

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

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

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

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

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

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

== Parameters ==
  * //canvas//
    * Type:Canvas
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} ThU=(Canvas) **

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

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

== Parameters ==
  * //canvas//
    * Type:Canvas
    * Description:N/A

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

Gets multiple wms uri addresses.
== Remarks ==
N/A
== Return Value ==
  * Type:Collection<Uri>

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

Gets a dictionary whose items will be passed to the WMS server as parameters.
== Remarks ==
N/A
== Return Value ==
  * Type:Dictionary<String,String>

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

Gets or sets a string that will be sent to the Wms server to get the images in the specific projection.
== Remarks ==
N/A
== Return Value ==
  * Type:String

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

This enumeration specifies whether the overlay uses tiling.
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.SilverlightEdition.TileType|TileType]]

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

Gets or sets whether the stretch effect is disabled or not.
== Remarks ==
If the wms images are transparent background, the stretched tiles will display right below the real tiles by the default value which affects your map.
== Return Value ==
  * Type:Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Gets a dictionary whose items will be passed to the TileOverlay server as parameters, it'll be used in the derived classes.
== Remarks ==
N/A
== Return Value ==
  * Type:Dictionary<String,String>

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

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

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

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

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

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

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

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

==== Public Events ====
** {{wiki:PublicEvent.gif|}} GetServerCapabilitiesXmlCompleted **
N/A
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.SilverlightEdition.GetServerCapabilitiesXmlCompletedWmsOverlayEventArgs|GetServerCapabilitiesXmlCompletedWmsOverlayEventArgs]]

** {{wiki:PublicEvent.gif|}} DrawingAttribution **
N/A
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.SilverlightEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]

** {{wiki:PublicEvent.gif|}} DrawnAttribution **
N/A
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.SilverlightEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]