User Tools

Site Tools

Trace: • thinkgeo.mapsuite.core.layeranchorlocation
thinkgeo.mapsuite.desktopedition.worldmapkitwmsdesktopoverlay

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
thinkgeo.mapsuite.desktopedition.worldmapkitwmsdesktopoverlay [2015/09/18 03:05]
admin 		thinkgeo.mapsuite.desktopedition.worldmapkitwmsdesktopoverlay [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay ====== ====== 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). This class is used in Desktop Edition to access the WorldMapKit Web Map Service (WMS).
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
Line 9: Line 12:
 ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay() ** ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay() **
  
-This is the constructor of the class.+  * //This is the constructor of the class.//
 == Remarks == == Remarks ==
-If you use this constructor,​ you must set the properties manually before use, otherwise it will use their default values.+  * //If you use this constructor,​ you must set the properties manually before use, otherwise it will use their default values.//
 == Parameters == == Parameters ==
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType) ** ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Parameters ==
   * //​layerType//​   * //​layerType//​
Line 27: Line 30:
 ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(String,​String) ** ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(String,​String) **
  
-This is the constructor of the class.+  * //This is the constructor of the class.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Parameters ==
   * //​clientId//​   * //​clientId//​
Line 42: Line 45:
 ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType,​String,​String) ** ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType,​String,​String) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Parameters ==
   * //​layerType//​   * //​layerType//​
Line 61: Line 64:
 ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WebProxy,​String,​String) ** ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WebProxy,​String,​String) **
  
-This is the constructor of the class.+  * //This is the constructor of the class.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Parameters ==
   * //​webProxy//​   * //​webProxy//​
Line 80: Line 83:
 ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType,​WebProxy,​String,​String) ** ** {{wiki:​PublicMethod.gif|}} WorldMapKitWmsDesktopOverlay(WorldMapKitLayerType,​WebProxy,​String,​String) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Parameters ==
   * //​layerType//​   * //​layerType//​
Line 105: Line 108:
 ** {{wiki:​PublicMethod.gif|}} ClearCache() ** ** {{wiki:​PublicMethod.gif|}} ClearCache() **
  
-This method will clear the cache for the Overlay.+  * //This method will clear the cache for the Overlay.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 117: Line 120:
 ** {{wiki:​PublicMethod.gif|}} Refresh(GeoCanvas,​RectangleShape) ** ** {{wiki:​PublicMethod.gif|}} Refresh(GeoCanvas,​RectangleShape) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 137: Line 140:
 ** {{wiki:​PublicMethod.gif|}} DrawPreview(GeoCanvas) ** ** {{wiki:​PublicMethod.gif|}} DrawPreview(GeoCanvas) **
  
-N/A+  * //This method will be used to draw preview tiles to the canvas.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]
-  * Description:​N/A+  * Description:​The tile existing type, which indicates whether any tiles exist.
  
 == Parameters == == Parameters ==
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:​N/A+    * Description:​This parameter is the canvas object to draw on.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​PublicMethod.gif|}} Draw(GeoCanvas) ** ** {{wiki:​PublicMethod.gif|}} Draw(GeoCanvas) **
  
-N/A+  * //This method draws the Overlay.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 164: Line 167:
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:​N/A+    * Description:​This parameter is the canvas object to draw on.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing() ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 181: Line 184:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 197: Line 200:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>​) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>​) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 213: Line 216:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(TimeSpan) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(TimeSpan) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 229: Line 232:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(TimeSpan,​RequestDrawingBufferTimeType) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(TimeSpan,​RequestDrawingBufferTimeType) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 249: Line 252:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape,​TimeSpan) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape,​TimeSpan) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 269: Line 272:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape,​TimeSpan,​RequestDrawingBufferTimeType) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape,​TimeSpan,​RequestDrawingBufferTimeType) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 293: Line 296:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>,​TimeSpan) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>,​TimeSpan) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 313: Line 316:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>,​TimeSpan,​RequestDrawingBufferTimeType) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>,​TimeSpan,​RequestDrawingBufferTimeType) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 337: Line 340:
 ** {{wiki:​PublicMethod.gif|}} ToString() ** ** {{wiki:​PublicMethod.gif|}} ToString() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 349: Line 352:
 ** {{wiki:​PublicMethod.gif|}} Equals(Object) ** ** {{wiki:​PublicMethod.gif|}} Equals(Object) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 365: Line 368:
 ** {{wiki:​PublicMethod.gif|}} GetHashCode() ** ** {{wiki:​PublicMethod.gif|}} GetHashCode() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 377: Line 380:
 ** {{wiki:​PublicMethod.gif|}} GetType() ** ** {{wiki:​PublicMethod.gif|}} GetType() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 390: Line 393:
 ** {{wiki:​ProtectedMethod.gif|}} DrawPreviewCore(GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} DrawPreviewCore(GeoCanvas) **
  
-This method overrides its DrawPreviewCore virtual method in its base class Overlay.+  * //This method overrides its DrawPreviewCore virtual method in its base class Overlay.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 406: Line 409:
 ** {{wiki:​ProtectedMethod.gif|}} DrawCore(GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} DrawCore(GeoCanvas) **
  
-This method draws the WorldMapKitDesktopOverlay.+  * //This method draws the WorldMapKitDesktopOverlay.//
 == Remarks == == 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.+  * //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 == == Return Value ==
   * Type:Void   * Type:Void
-  * Description:​None+  * Description:​N/A
  
 == Parameters == == Parameters ==
Line 422: Line 425:
 ** {{wiki:​ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,​Exception) ** ** {{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.+  * //This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 442: Line 445:
 ** {{wiki:​ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 458: Line 461:
 ** {{wiki:​ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 474: Line 477:
 ** {{wiki:​ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) **
  
-N/A+  * //This event will be fired before Overlay is drawn.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 485: Line 488:
   * //e//   * //e//
     * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]     * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
-    * Description:​N/A+    * Description:​The OverlayDrawingEventArgs passed for the event raised.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) **
  
-N/A+  * //This event will be fired after Overlay is drawn.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 501: Line 504:
   * //e//   * //e//
     * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]     * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
-    * Description:​N/A+    * Description:​The OverlayDrawnEventArgs passed for the event raised.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​ProtectedMethod.gif|}} RefreshCore(GeoCanvas,​RectangleShape) ** ** {{wiki:​ProtectedMethod.gif|}} RefreshCore(GeoCanvas,​RectangleShape) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 526: Line 529:
 ** {{wiki:​ProtectedMethod.gif|}} sBM=(GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} sBM=(GeoCanvas) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 542: Line 545:
 ** {{wiki:​ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 558: Line 561:
 ** {{wiki:​ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 574: Line 577:
 ** {{wiki:​ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 590: Line 593:
 ** {{wiki:​ProtectedMethod.gif|}} DrawException(GeoCanvas,​Exception) ** ** {{wiki:​ProtectedMethod.gif|}} DrawException(GeoCanvas,​Exception) **
  
-N/A+  * //This method will draw on the canvas when an exception occurs during the drawing process.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 601: Line 604:
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:​N/A+    * Description:​This parameter is the canvas object to draw on.
  
   * //e//   * //e//
     * Type:​Exception     * Type:​Exception
-    * Description:​N/A+    * Description:​This parameter is the exception that is occurring.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingOverlayEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 626: Line 629:
 ** {{wiki:​ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingOverlayEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 642: Line 645:
 ** {{wiki:​ProtectedMethod.gif|}} Finalize() ** ** {{wiki:​ProtectedMethod.gif|}} Finalize() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 654: Line 657:
 ** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() ** ** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
Line 666: Line 669:
 ** {{wiki:​ProtectedMethod.gif|}}{{wiki:​Static.gif|}} HBU=(Bitmap,​RectangleShape,​RectangleShape,​Double,​Int32,​Int32) ** ** {{wiki:​ProtectedMethod.gif|}}{{wiki:​Static.gif|}} HBU=(Bitmap,​RectangleShape,​RectangleShape,​Double,​Int32,​Int32) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 703: Line 706:
 ** {{wiki:​PublicProperty.gif|}} ClientId ** ** {{wiki:​PublicProperty.gif|}} ClientId **
  
-Gets or sets a value that is your Client Id.+  * //Gets or sets a value that is your Client Id.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​ClientId/​/
 == Return Value == == Return Value ==
   * Type:String   * Type:String
Line 711: Line 714:
 ** {{wiki:​PublicProperty.gif|}} PrivateKey ** ** {{wiki:​PublicProperty.gif|}} PrivateKey **
  
-Gets or sets a value that is unique to your client ID, please keep your key secure.+  * //Gets or sets a value that is unique to your client ID, please keep your key secure.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​PrivateKey/​/
 == Return Value == == Return Value ==
   * Type:String   * Type:String
Line 719: Line 722:
 ** {{wiki:​PublicProperty.gif|}} LayerType ** ** {{wiki:​PublicProperty.gif|}} LayerType **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]   * Type:​[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]
Line 727: Line 730:
 ** {{wiki:​PublicProperty.gif|}} MapType ** ** {{wiki:​PublicProperty.gif|}} MapType **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.WorldMapKitMapType|WorldMapKitMapType]]   * Type:​[[ThinkGeo.MapSuite.Core.WorldMapKitMapType|WorldMapKitMapType]]
Line 735: Line 738:
 ** {{wiki:​PublicProperty.gif|}} Projection ** ** {{wiki:​PublicProperty.gif|}} Projection **
  
-Gets or sets the Projection of the Overlay.+  * //Gets or sets the Projection of the Overlay.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​Projection/​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]]   * Type:​[[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]]
Line 743: Line 746:
 ** {{wiki:​PublicProperty.gif|}} TileCache ** ** {{wiki:​PublicProperty.gif|}} TileCache **
  
-Gets or sets the BitmapTileCache for the Overlay.+  * //Gets or sets the BitmapTileCache for the Overlay.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​PreviewTileCache/​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]
Line 751: Line 754:
 ** {{wiki:​PublicProperty.gif|}} WebProxy ** ** {{wiki:​PublicProperty.gif|}} WebProxy **
  
-This property gets or sets the proxy used for requesting a Web Response.+  * //This property gets or sets the proxy used for requesting a Web Response.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
   * Type:​WebProxy   * Type:​WebProxy
Line 759: Line 762:
 ** {{wiki:​PublicProperty.gif|}} Attribution ** ** {{wiki:​PublicProperty.gif|}} Attribution **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
   * Type:String   * Type:String
Line 767: Line 770:
 ** {{wiki:​PublicProperty.gif|}} Lock ** ** {{wiki:​PublicProperty.gif|}} Lock **
  
-N/A+  * //This property gets the OverlayLock object.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​Lock/​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]]   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]]
Line 775: Line 778:
 ** {{wiki:​PublicProperty.gif|}} IsBase ** ** {{wiki:​PublicProperty.gif|}} IsBase **
  
-N/A+  * //Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​IsBase/​/
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 783: Line 786:
 ** {{wiki:​PublicProperty.gif|}} DrawingExceptionMode ** ** {{wiki:​PublicProperty.gif|}} DrawingExceptionMode **
  
-N/A+  * //This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​DrawingExceptionMode/​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]   * Type:​[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]
Line 791: Line 794:
 ** {{wiki:​PublicProperty.gif|}} IsVisible ** ** {{wiki:​PublicProperty.gif|}} IsVisible **
  
-N/A+  * //Gets or sets a value that indicates whether the overlay is visible on the map.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​IsVisible/​/
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 799: Line 802:
 ** {{wiki:​PublicProperty.gif|}} Name ** ** {{wiki:​PublicProperty.gif|}} Name **
  
-N/A+  * //Gets or sets the name of the overlay, which can be used to represent a specific overlay.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​Name/​/
 == Return Value == == Return Value ==
   * Type:String   * Type:String
Line 807: Line 810:
 ** {{wiki:​PublicProperty.gif|}} PreviewTileCache ** ** {{wiki:​PublicProperty.gif|}} PreviewTileCache **
  
-N/A+  * //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 == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​PreviewTileCache/​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]
Line 815: Line 818:
 ** {{wiki:​PublicProperty.gif|}} IsEmpty ** ** {{wiki:​PublicProperty.gif|}} IsEmpty **
  
-N/A+  * //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 == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay#​IsEmpty/​/
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 823: Line 826:
 ** {{wiki:​PublicProperty.gif|}} DrawingTime ** ** {{wiki:​PublicProperty.gif|}} DrawingTime **
  
-N/A+  * //This property gets the last drawing time for the Overlay.//
 == Remarks == == Remarks ==
-N/A+  * //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 == == Return Value ==
   * Type:​TimeSpan   * Type:​TimeSpan
Line 831: Line 834:
 ** {{wiki:​PublicProperty.gif|}} AutoRefreshInterval ** ** {{wiki:​PublicProperty.gif|}} AutoRefreshInterval **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
 == Return Value == == Return Value ==
   * Type:​TimeSpan   * Type:​TimeSpan
Line 840: Line 843:
 ** {{wiki:​ProtectedProperty.gif|}} rxM= ** ** {{wiki:​ProtectedProperty.gif|}} rxM= **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
Line 848: Line 851:
 ==== Public Events ==== ==== Public Events ====
 ** {{wiki:​PublicEvent.gif|}} SendingWebRequest ** ** {{wiki:​PublicEvent.gif|}} SendingWebRequest **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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]] Event Arguments:​[[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} SentWebRequest ** ** {{wiki:​PublicEvent.gif|}} SentWebRequest **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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]] Event Arguments:​[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} Drawing ** ** {{wiki:​PublicEvent.gif|}} Drawing **
-N/A+  * //This event will be fired before the Overlay is drawn.//
 == Remarks == == Remarks ==
-N/A+  * //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]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} Drawn ** ** {{wiki:​PublicEvent.gif|}} Drawn **
-N/A+  * //This event will be fired after the Overlay is drawn.//
 == Remarks == == Remarks ==
-N/A+  * //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]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} DrawingAttribution ** ** {{wiki:​PublicEvent.gif|}} DrawingAttribution **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} DrawnAttribution ** ** {{wiki:​PublicEvent.gif|}} DrawnAttribution **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //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]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} RequestedDrawing ** ** {{wiki:​PublicEvent.gif|}} RequestedDrawing **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} RequestingDrawing ** ** {{wiki:​PublicEvent.gif|}} RequestingDrawing **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]
  
  
thinkgeo.mapsuite.desktopedition.worldmapkitwmsdesktopoverlay.1442545542.txt.gz · Last modified: 2015/09/18 03:05 by admin

Page Tools