ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay ======
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 ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType) **

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

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

This is the constructor of the class.
== Remarks ==
N/A
== Parameters ==
  * //clientId//
    * Type:String
    * Description:The clientId for the WMS Server.

  * //privateKey//
    * Type:String
    * Description:The privateKey for the WMS Server.

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

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

  * //clientId//
    * Type:String
    * Description:N/A

  * //privateKey//
    * Type:String
    * Description:N/A

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

This is the constructor of the class.
== Remarks ==
N/A
== 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.

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

N/A
== Remarks ==
N/A
== 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

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

This method will clear the cache for the Overlay.
== Remarks ==
N/A

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

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

N/A
== Remarks ==
N/A

== 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

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

N/A
== Remarks ==
N/A

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

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

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

N/A
== Remarks ==
N/A

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

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

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

N/A
== Remarks ==
N/A

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

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

N/A
== Remarks ==
N/A

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

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

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

N/A
== Remarks ==
N/A

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

== Parameters ==
  * //extentsToRefresh//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
    * Description:N/A

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

N/A
== Remarks ==
N/A

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

== Parameters ==
  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) **

N/A
== Remarks ==
N/A

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

== Parameters ==
  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) **

N/A
== Remarks ==
N/A

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

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

  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) **

N/A
== Remarks ==
N/A

== 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

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) **

N/A
== Remarks ==
N/A

== 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

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) **

N/A
== Remarks ==
N/A

== 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

<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|}} DrawPreviewCore(GeoCanvas) **

This method overrides its DrawPreviewCore virtual method in its base class Overlay.
== Remarks ==
N/A

== 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.

<div newline></div>
** {{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:None

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:This parameter is the canvas object or a GeoImage to draw on.

<div newline></div>
** {{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 ==
N/A

== 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().

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

N/A
== Remarks ==
N/A

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

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

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

N/A
== Remarks ==
N/A

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

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

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

N/A
== Remarks ==
N/A

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

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

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

N/A
== Remarks ==
N/A

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

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

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

N/A
== Remarks ==
N/A

== 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

<div newline></div>
** {{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

<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.Core.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.DesktopEdition.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.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
    * Description:N/A

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

N/A
== Remarks ==
N/A

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

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

  * //e//
    * Type:Exception
    * Description:N/A

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

N/A
== Remarks ==
N/A

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

== Parameters ==
  * //eventArgs//
    * Type:[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]
    * Description:N/A

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

N/A
== Remarks ==
N/A

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

== Parameters ==
  * //eventArgs//
    * Type:[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]
    * Description:N/A

<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|}} 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

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

Gets or sets a value that is your Client Id.
== Remarks ==
N/A
== 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 ==
N/A
== Return Value ==
  * Type:String

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

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

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

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

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

Gets or sets the Projection of the Overlay.
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]]

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

Gets or sets the BitmapTileCache for the Overlay.
== Remarks ==
N/A
== 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 ==
N/A
== Return Value ==
  * Type:WebProxy

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

N/A
== Remarks ==
N/A
== 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 ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]]

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

Event Arguments:[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]]

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

Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]

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

Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]

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

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

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

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

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

Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]

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

Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]
User Tools

Site Tools

Page Tools
