====== ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay ======
{{section>upgrade_map_suite_to_10.0}}
This class is used in Desktop Edition to access the WorldMapKit Web Map Service (WMS).
===== Inheritance Hierarchy =====
*System.Object
*ThinkGeo.MapSuite.DesktopEdition.Overlay
***ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay() **
* //This is the constructor of the class.//
== Remarks ==
* //If you use this constructor, you must set the properties manually before use, otherwise it will use their default values.//
== Parameters ==
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#WorldMapKitWmsDesktopOverlay.28WorldMapKitLayerType.29//
== Parameters ==
* //layerType//
* Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(String,String) **
* //This is the constructor of the class.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#WorldMapKitWmsDesktopOverlay.28String.2C_String.29//
== Parameters ==
* //clientId//
* Type:String
* Description:The clientId for the WMS Server.
* //privateKey//
* Type:String
* Description:The privateKey for the WMS Server.
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType,String,String) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#WorldMapKitWmsDesktopOverlay.28WorldMapKitLayerType.2C_String.2C_String.29//
== Parameters ==
* //layerType//
* Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]
* Description:N/A
* //clientId//
* Type:String
* Description:N/A
* //privateKey//
* Type:String
* Description:N/A
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WebProxy,String,String) **
* //This is the constructor of the class.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#WorldMapKitWmsDesktopOverlay.28WebProxy.2C_String.2C_String.29//
== Parameters ==
* //webProxy//
* Type:WebProxy
* Description:Proxy to use for the WMS Server.
* //clientId//
* Type:String
* Description:The clientId for the WMS Server.
* //privateKey//
* Type:String
* Description:The privateKey for the WMS Server.
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType,WebProxy,String,String) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#WorldMapKitWmsDesktopOverlay.28WorldMapKitLayerType.2C_WebProxy.2C_String.2C_String.29//
== Parameters ==
* //layerType//
* Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]
* Description:N/A
* //webProxy//
* Type:WebProxy
* Description:N/A
* //clientId//
* Type:String
* Description:N/A
* //privateKey//
* Type:String
* Description:N/A
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} ClearCache() **
* //This method will clear the cache for the Overlay.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#ClearCache.28.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Refresh(GeoCanvas,RectangleShape) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#Refresh.28GeoCanvas.2C_RectangleShape.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:N/A
* //extent//
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} DrawPreview(GeoCanvas) **
* //This method will be used to draw preview tiles to the canvas.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#DrawPreview.28GeoCanvas.29//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]
* Description:The tile existing type, which indicates whether any tiles exist.
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:This parameter is the canvas object to draw on.
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas) **
* //This method draws the Overlay.//
== Remarks ==
* //This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the overlay based on the extent you provided. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:This parameter is the canvas object to draw on.
** {{wiki:PublicMethod.gif|}} RequestDrawing() **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentToRefresh//
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentsToRefresh//
* Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
* Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //bufferTime//
* Type:TimeSpan
* Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //bufferTime//
* Type:TimeSpan
* Description:N/A
* //bufferTimeType//
* Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentToRefresh//
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
* //bufferTime//
* Type:TimeSpan
* Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentToRefresh//
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
* //bufferTime//
* Type:TimeSpan
* Description:N/A
* //bufferTimeType//
* Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentsToRefresh//
* Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
* Description:N/A
* //bufferTime//
* Type:TimeSpan
* Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan,RequestDrawingBufferTimeType) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentsToRefresh//
* Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
* Description:N/A
* //bufferTime//
* Type:TimeSpan
* Description:N/A
* //bufferTimeType//
* Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
* Description:N/A
** {{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.DesktopEdition.WorldMapKitWmsDesktopOverlay#ToString.28.29//
== Return Value ==
* Type:String
* Description:N/A
== Parameters ==
** {{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.DesktopEdition.WorldMapKitWmsDesktopOverlay#Equals.28Object.29//
== Return Value ==
* Type:Boolean
* Description:N/A
== Parameters ==
* //obj//
* Type:Object
* Description:N/A
** {{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.DesktopEdition.WorldMapKitWmsDesktopOverlay#GetHashCode.28.29//
== Return Value ==
* Type:Int32
* Description:N/A
== Parameters ==
** {{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.DesktopEdition.WorldMapKitWmsDesktopOverlay#GetType.28.29//
== Return Value ==
* Type:Type
* Description:N/A
== Parameters ==
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} DrawPreviewCore(GeoCanvas) **
* //This method overrides its DrawPreviewCore virtual method in its base class Overlay.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#DrawPreviewCore.28GeoCanvas.29//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]
* Description:The tile existing type, which indicates whether any tiles exist.
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:This parameter is the canvas object to draw on.
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas) **
* //This method draws the WorldMapKitDesktopOverlay.//
== Remarks ==
* //This method draws the representation of the overlay based on the extent you provided. When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:This parameter is the canvas object or a GeoImage to draw on.
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) **
* //This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#DrawExceptionCore.28GeoCanvas.2C_Exception.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:The target canvas to draw the layer.
* //e//
* Type:Exception
* Description:The exception thrown when layer.Draw().
** {{wiki:ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnSendingWebRequest.28SendingWebRequestEventArgs.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //e//
* Type:[[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnSentWebRequest.28SentWebRequestEventArgs.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //e//
* Type:[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) **
* //This event will be fired before Overlay is drawn.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnDrawing.28DrawingOverlayEventArgs.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //e//
* Type:[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
* Description:The OverlayDrawingEventArgs passed for the event raised.
** {{wiki:ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) **
* //This event will be fired after Overlay is drawn.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnDrawn.28DrawnOverlayEventArgs.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //e//
* Type:[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
* Description:The OverlayDrawnEventArgs passed for the event raised.
** {{wiki:ProtectedMethod.gif|}} RefreshCore(GeoCanvas,RectangleShape) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#RefreshCore.28GeoCanvas.2C_RectangleShape.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:N/A
* //extent//
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} sBM=(GeoCanvas) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#DrawAttributionCore.28GeoCanvas.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //args//
* Type:[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //args//
* Type:[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) **
* //This method will draw on the canvas when an exception occurs during the drawing process.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#DrawException.28GeoCanvas.2C_Exception.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:This parameter is the canvas object to draw on.
* //e//
* Type:Exception
* Description:This parameter is the exception that is occurring.
** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingOverlayEventArgs) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //eventArgs//
* Type:[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingOverlayEventArgs) **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //eventArgs//
* Type:[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]
* Description:N/A
** {{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.DesktopEdition.WorldMapKitWmsDesktopOverlay#Finalize.28.29//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{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.DesktopEdition.WorldMapKitWmsDesktopOverlay#MemberwiseClone.28.29//
== Return Value ==
* Type:Object
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} HBU=(Bitmap,RectangleShape,RectangleShape,Double,Int32,Int32) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
* Description:N/A
== Parameters ==
* //higherScaleTileImage//
* Type:Bitmap
* Description:N/A
* //higherScaleTileExtent//
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
* //previewExtent//
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
* //previewScale//
* Type:Double
* Description:N/A
* //previewImageWidth//
* Type:Int32
* Description:N/A
* //previewImageHeight//
* Type:Int32
* Description:N/A
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} ClientId **
* //Gets or sets a value that is your Client Id.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#ClientId//
== Return Value ==
* Type:String
** {{wiki:PublicProperty.gif|}} PrivateKey **
* //Gets or sets a value that is unique to your client ID, please keep your key secure.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#PrivateKey//
== Return Value ==
* Type:String
** {{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.DesktopEdition.WorldMapKitWmsDesktopOverlay#WorldMapKitWmsDesktopOverlay.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|}} Projection **
* //Gets or sets the Projection of the Overlay.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#Projection//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]]
** {{wiki:PublicProperty.gif|}} TileCache **
* //Gets or sets the BitmapTileCache for the Overlay.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#PreviewTileCache//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]
** {{wiki:PublicProperty.gif|}} WebProxy **
* //This property gets or sets the proxy used for requesting a Web Response.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#WorldMapKitWmsDesktopOverlay.28WebProxy.2C_String.2C_String.29//
== Return Value ==
* Type:WebProxy
** {{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.DesktopEdition.WorldMapKitWmsDesktopOverlay#DrawAttributionCore.28GeoCanvas.29//
== Return Value ==
* Type:String
** {{wiki:PublicProperty.gif|}} Lock **
* //This property gets the OverlayLock object.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#Lock//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]]
** {{wiki:PublicProperty.gif|}} IsBase **
* //Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#IsBase//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} DrawingExceptionMode **
* //This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#DrawingExceptionMode//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]
** {{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.DesktopEdition.WorldMapKitWmsDesktopOverlay#IsVisible//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} Name **
* //Gets or sets the name of the overlay, which can be used to represent a specific overlay.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#Name//
== Return Value ==
* Type:String
** {{wiki:PublicProperty.gif|}} PreviewTileCache **
* //This property gets or sets the preview tile cache system. In order for this system to work, you must be in multi-threaded mode and have the tile cache set.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#PreviewTileCache//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]
** {{wiki:PublicProperty.gif|}} IsEmpty **
* //This property can be overridden by its base class. If it is not overridden, its default return value will be false. If this property is empty, we can skip drawing to achieve better performance.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#IsEmpty//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} DrawingTime **
* //This property gets the last drawing time for the Overlay.//
== Remarks ==
* //We track the drawing time for the Overlay and report it back in this method. This is useful to determine the speed of various Overlays.//
== Return Value ==
* Type:TimeSpan
** {{wiki:PublicProperty.gif|}} AutoRefreshInterval **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
== Return Value ==
* Type:TimeSpan
==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} rxM= **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
==== Public Events ====
** {{wiki:PublicEvent.gif|}} SendingWebRequest **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnSendingWebRequest.28SendingWebRequestEventArgs.29//
Event Arguments:[[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]]
** {{wiki:PublicEvent.gif|}} SentWebRequest **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnSentWebRequest.28SentWebRequestEventArgs.29//
Event Arguments:[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]]
** {{wiki:PublicEvent.gif|}} Drawing **
* //This event will be fired before the Overlay is drawn.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnDrawing.28DrawingOverlayEventArgs.29//
Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
** {{wiki:PublicEvent.gif|}} Drawn **
* //This event will be fired after the Overlay is drawn.//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnDrawn.28DrawnOverlayEventArgs.29//
Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
** {{wiki:PublicEvent.gif|}} DrawingAttribution **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29//
Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
** {{wiki:PublicEvent.gif|}} DrawnAttribution **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29//
Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
** {{wiki:PublicEvent.gif|}} RequestedDrawing **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]
** {{wiki:PublicEvent.gif|}} RequestingDrawing **
* //N/A//
== Remarks ==
* //For the most updated Info for this topic, please check it here://
Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]