====== ThinkGeo.MapSuite.WinForms.WorldMapKitWmsDesktopOverlay ====== ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.WinForms.Overlay ***ThinkGeo.MapSuite.WinForms.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 == * //N/A// == Parameters == * //layerType// * Type:[[ThinkGeo.MapSuite.WinForms.WorldMapKitLayerType|WorldMapKitLayerType]] * Description:N/A
** {{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.
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType,String,String) ** * //N/A// == Remarks == * //N/A// == Parameters == * //layerType// * Type:[[ThinkGeo.MapSuite.WinForms.WorldMapKitLayerType|WorldMapKitLayerType]] * Description:N/A * //clientId// * Type:String * Description:N/A * //privateKey// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(IWebProxy,String,String) ** * //This is the constructor of the class.// == Remarks == * //N/A// == Parameters == * //webProxy// * Type:IWebProxy * 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,IWebProxy,String,String) ** * //N/A// == Remarks == * //N/A// == Parameters == * //layerType// * Type:[[ThinkGeo.MapSuite.WinForms.WorldMapKitLayerType|WorldMapKitLayerType]] * Description:N/A * //webProxy// * Type:IWebProxy * Description:N/A * //clientId// * Type:String * Description:N/A * //privateKey// * Type:String * Description:N/A
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} ClearCache() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Refresh(GeoCanvas,RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //extent// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} DrawPreview(GeoCanvas) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.WinForms.TilesExistingType|TilesExistingType]] * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A
** {{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.Layers.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Layers.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Layers.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
===== Protected Methods ===== ** {{wiki:ProtectedMethod.gif|}} DrawPreviewCore(GeoCanvas) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.WinForms.TilesExistingType|TilesExistingType]] * Description:The tile existing type, which indicates whether any tiles exist. == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:This parameter is the canvas object to draw on.
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas) ** * //N/A// == 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.Drawing.GeoCanvas|GeoCanvas]] * Description:This parameter is the canvas object or a GeoImage to draw on.
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.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 == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Layers.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Layers.SentWebRequestEventArgs|SentWebRequestEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.WinForms.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.WinForms.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} RefreshCore(GeoCanvas,RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //extent// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawAttribution(GeoCanvas) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.WinForms.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.WinForms.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //e// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.MapSuite.WinForms.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.MapSuite.WinForms.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} GetCompressedOrStretchedTile(Bitmap,RectangleShape,RectangleShape,Double,Int32,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.BitmapTile|BitmapTile]] * Description:N/A == Parameters == * //higherScaleTileImage// * Type:Bitmap * Description:N/A * //higherScaleTileExtent// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A * //previewExtent// * Type:[[ThinkGeo.MapSuite.Shapes.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 ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} PrivateKey ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} LayerType ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.WinForms.WorldMapKitLayerType|WorldMapKitLayerType]] ** {{wiki:PublicProperty.gif|}} MapType ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.WinForms.WorldMapKitMapType|WorldMapKitMapType]] ** {{wiki:PublicProperty.gif|}} Projection ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.WinForms.WorldMapKitProjection|WorldMapKitProjection]] ** {{wiki:PublicProperty.gif|}} TileCache ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.BitmapTileCache|BitmapTileCache]] ** {{wiki:PublicProperty.gif|}} WebProxy ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:IWebProxy ** {{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.WinForms.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.Drawing.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.Layers.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|}} ScreenBitmapTile ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.BitmapTile|BitmapTile]] ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} SendingWebRequest ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] ** {{wiki:PublicEvent.gif|}} SentWebRequest ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.SentWebRequestEventArgs|SentWebRequestEventArgs]] ** {{wiki:PublicEvent.gif|}} Drawing ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.WinForms.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] ** {{wiki:PublicEvent.gif|}} Drawn ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.WinForms.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.WinForms.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.WinForms.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.WinForms.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.WinForms.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]