User Tools

Site Tools


thinkgeo.mapsuite.desktopedition.overlay

Differences

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

Link to this comparison view

Next revision
Previous revision
thinkgeo.mapsuite.desktopedition.overlay [2015/08/20 03:08]
127.0.0.1 external edit
thinkgeo.mapsuite.desktopedition.overlay [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.DesktopEdition.Overlay ====== ====== ThinkGeo.MapSuite.DesktopEdition.Overlay ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 Serves as the base class that defines the properties and methods shared by all types of overlays. Serves as the base class that defines the properties and methods shared by all types of overlays.
-=== Remarks === 
-The &​lt;​strong&​gt;​Overlay&​lt;/​strong&​gt;​ has a similar concept to that of the Layer. Different types of overlays stack over each other to form a map.Usually,​ an overlay represents an image with a transparent background that is laid upon other overlay, such as a &​lt;​strong&​gt;​LayerOverlay&​lt;/​strong&​gt;​ or &​lt;​strong&​gt;​WmsOverlay&​lt;/​strong&​gt;​.There are basically two kinds of overlays: base overlays and non-base overlays.A base overlay has its &​lt;​strong&​gt;​IsBase&​lt;/​strong&​gt;​ property set to true. It is displayed as the background image of the map.A non-base overlay has a false &​lt;​strong&​gt;​IsBase&​lt;/​strong&​gt;​ property. These overlays can overlap the base overlay and/or each other. 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.DesktopEdition.Overlay]] +    ***ThinkGeo.MapSuite.DesktopEdition.Overlay** 
-***[[ThinkGeo.MapSuite.DesktopEdition.AdornmentOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.AdornmentOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.BingMapsOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.EditInteractiveOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.BingMapsOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.ExtentInteractiveOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.FeatureSourceMarkerOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.LayerOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.InMemoryMarkerOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.OpenStreetMapOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.LayerOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.WmtsOverlay]] 
-***[[ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay]] +      *[[ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay]]
-***[[ThinkGeo.MapSuite.DesktopEdition.OpenStreetMapOverlay]] +
-***[[ThinkGeo.MapSuite.DesktopEdition.PrinterInteractiveOverLay]] +
-***[[ThinkGeo.MapSuite.DesktopEdition.SimpleMarkerOverlay]] +
-***[[ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay]] +
-***[[ThinkGeo.MapSuite.DesktopEdition.TrackInteractiveOverlay]] +
-***[[ThinkGeo.MapSuite.DesktopEdition.WmtsOverlay]] +
-***[[ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay]]+
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
 ==== Protected Constructors ==== ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​ProtectedMethod.gif|}} Overlay() ​**
-{{wiki:​ProtectedMethod.gif|Protected Method}}[[#Overlay()|Overlay]] ​  ​| ​   |    | Initialize an instance of the Overlay class. ​  |+
  
 +  * //​Initialize an instance of the Overlay class.//
 +== Remarks ==
 +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Overlay.28.29//​
 +== Parameters ==
 +<div newline></​div>​
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} ​Refresh(GeoCanvas,​RectangleShape** 
-{{wiki:​PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas)|Draw]] ​  ​| ​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] ​  |    | This method draws the Overlay  ​+ 
-{{wiki:​PublicMethod.gif|Public Method}}[[#DrawPreview(GeoCanvas)|DrawPreview]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] ​  |    This method will be used to draw preview tiles to the canvas. ​  | +  * //N/A// 
-{{wiki:​PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object ​  | Object ​  ​| ​   | +== Remarks == 
-{{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Refresh.28GeoCanvas.2C_RectangleShape.29//​ 
-{{wiki:​PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object ​  ​| ​   | + 
-{{wiki:​PublicMethod.gif|Public Method}}[[#Refresh(GeoCanvas, ​RectangleShape)|Refresh]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] ​  |    |    | +== Return Value == 
-{{wiki:​PublicMethod.gif|Public Method}}[[#RequestDrawing()|RequestDrawing]] ​  ​| ​   |    |    | +  * Type:Void 
-{{wiki:​PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<​RectangleShape>, ​TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] ​  | IEnumerable<​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]   |       | +  * Description:​N/​A 
-{{wiki:​PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape,​ TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] ​  ​| ​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]TimeSpan[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] ​  |    |    | + 
-{{wiki:​PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape,​ TimeSpan)|RequestDrawing]] ​  ​| ​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan ​  ​| ​      | +== Parameters == 
-{{wiki:​PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan,​ RequestDrawingBufferTimeType)|RequestDrawing]] ​  | TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]   |       | +  * //​canvas//​ 
-| {{wiki:PublicMethod.gif|Public Method}}[[#​RequestDrawing(TimeSpan)|RequestDrawing]]   | TimeSpan ​  ​| ​   |    | +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-{{wiki:​PublicMethod.gif|Public Method}}[[#​RequestDrawing(IEnumerable<​RectangleShape>​)|RequestDrawing]] ​  | IEnumerable<​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]  |    |    | +    * Description:​N/​A 
-{{wiki:​PublicMethod.gif|Public Method}}[[#​RequestDrawing(IEnumerable<​RectangleShape>,​ TimeSpan)|RequestDrawing]] ​  | IEnumerable<​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>,​ TimeSpan ​  ​| ​      | + 
-{{wiki:​PublicMethod.gif|Public Method}}[[#​RequestDrawing(RectangleShape)|RequestDrawing]] ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] ​  ​| ​   |    | +  * //​extent//​ 
-{{wiki:​PublicMethod.gif|Public Method}}[[#ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   |+    * Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
 +    * Description:​N/​A 
 + 
 +<div newline></​div>​ 
 +** {{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.Overlay#​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
 + 
 +<div newline></​div>​ 
 +** {{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. 
 + 
 +<div newline></​div>​ 
 +** {{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 == 
 +<div newline></​div>​ 
 +** {{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 
 + 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} ​RequestDrawing(IEnumerable<​RectangleShape>** 
 + 
 +  * //N/A// 
 +== Remarks == 
 +  * //For the most updated Info for this topicplease check it here:// 
 + 
 +== 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 == 
 +  * //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 
 + 
 +<div newline></​div>​ 
 +** {{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 
 + 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** 
 + 
 +  * //N/A// 
 +== Remarks == 
 +  * //For the most updated Info for this topicplease 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 
 + 
 +<div newline></​div>​ 
 +** {{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 
 + 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​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 == 
 +  * //​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 == 
 +  * //For the most updated Info for this topicplease 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 
 + 
 +<div newline></​div>​ 
 +** {{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.Overlay#​ToString.28.29//​ 
 + 
 +== Return Value == 
 +  * Type:​String 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +<div newline></​div
 +** {{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.Overlay#​Equals.28Object.29//​ 
 + 
 +== Return Value == 
 +  * Type:​Boolean 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +  * //obj// 
 +    * Type:​Object 
 +    * Description:​N/​A 
 + 
 +<div newline></​div>​ 
 +** {{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.Overlay#​GetHashCode.28.29//​ 
 + 
 +== Return Value == 
 +  * Type:​Int32 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +<div newline></​div>​ 
 +** {{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.Overlay#​GetType.28.29//​ 
 + 
 +== Return Value == 
 +  * Type:Type 
 +  * Description:​N/​A
  
 +== Parameters ==
 +<div newline></​div>​
 ==== Protected Methods ==== ==== Protected Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) ​**
-{{wiki:​ProtectedMethod.gif|Protected Method}}[[#​DrawAttributionCore(GeoCanvas)|DrawAttributionCore]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] ​  ​| ​   |    | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​DrawCore(GeoCanvas)|DrawCore]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] ​  ​| ​   | This method draws the Overlay. ​  | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​DrawException(GeoCanvas,​ Exception)|DrawException]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​ Exception ​  ​| ​   | This method will draw on the canvas when an exception occurs during the drawing process. ​  | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​DrawExceptionCore(GeoCanvas,​ Exception)|DrawExceptionCore]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​ Exception ​  ​| ​   | This method is the Core method of DrawException,​ which can be overridden if you want to change its logic. This method will draw on the canvas when an exception occurs during drawing process. ​  | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​DrawPreviewCore(GeoCanvas)|DrawPreviewCore]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] ​  ​| ​   | This is the core method of DrawPreview which is intended to be overridden by its concrete sub class. ​  | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#OnDrawing(DrawingOverlayEventArgs)|OnDrawing]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] ​  ​| ​   | This event will be fired before Overlay is drawn. ​  | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​OnDrawingAttribution(DrawingAttributionOverlayEventArgs)|OnDrawingAttribution]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] ​  ​| ​   |    | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​OnDrawn(DrawnOverlayEventArgs)|OnDrawn]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] ​  ​| ​   | This event will be fired after Overlay is drawn. ​  | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​OnDrawnAttribution(DrawnAttributionOverlayEventArgs)|OnDrawnAttribution]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] ​  ​| ​   |    | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​OnRequestedDrawing(RequestedDrawingOverlayEventArgs)|OnRequestedDrawing]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] ​  ​| ​   |    | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​OnRequestingDrawing(RequestingDrawingOverlayEventArgs)|OnRequestingDrawing]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] ​  ​| ​   |    | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​RefreshCore(GeoCanvas,​ RectangleShape)|RefreshCore]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​ [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] ​  ​| ​   |    |+
  
-==== Public Properties ==== +  * //This event will be fired before Overlay is drawn.// 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +== Remarks ​== 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Attribution|Attribution]] ​  | String ​  ​| ​   |    | +  * //For the most updated Info for this topicplease check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawing.28DrawingOverlayEventArgs.29//
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​AutoRefreshInterval|AutoRefreshInterval]] ​  | TimeSpan ​  ​| ​   |    | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​DrawingExceptionMode|DrawingExceptionMode]] ​  | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] ​  ​| ​   | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​DrawingTime|DrawingTime]] ​  | TimeSpan ​  ​| ​   | This property gets the last drawing time for the Overlay. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsBase|IsBase]] ​  | Boolean ​  ​| ​   | Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsEmpty|IsEmpty]] ​  | Boolean ​  ​| ​   | 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 emptywe can skip drawing to achieve better performance. ​  | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​IsVisible|IsVisible]] ​  | Boolean ​  ​| ​   | Gets or sets a value that indicates whether the overlay is visible on the map.   | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​Lock|Lock]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]] ​  ​| ​   | This property gets the OverlayLock object. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Name|Name]] ​  | String ​  ​| ​   | Gets or sets the name of the overlay, which can be used to represent a specific overlay  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​PreviewTileCache|PreviewTileCache]] ​  | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] ​  ​| ​   | 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.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#TileCache|TileCache]] ​  | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] ​  ​| ​   | This property gets or sets the TileCache used for the overlay. ​  |+
  
-==== Protected Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+  * Type:Void 
 +  * Description:​N/​A
  
-==== Public Events ==== +== Parameters ​== 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ +  * //e// 
-| {{wiki:PublicEvent.gif|Public Event}}[[#​Drawing|Drawing]] ​  ​| ​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] ​  |    | This event will be fired before the Overlay is drawn. ​  | +    * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] 
-| {{wiki:​PublicEvent.gif|Public Event}}[[#​DrawingAttribution|DrawingAttribution]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] ​  ​| ​   |    | +    ​* Description:The OverlayDrawingEventArgs passed for the event raised.
-| {{wiki:PublicEvent.gif|Public Event}}[[#​Drawn|Drawn]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] ​  ​| ​   | This event will be fired after the Overlay is drawn  | +
-| {{wiki:​PublicEvent.gif|Public Event}}[[#​DrawnAttribution|DrawnAttribution]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] ​  ​| ​   |    | +
-| {{wiki:​PublicEvent.gif|Public Event}}[[#​RequestedDrawing|RequestedDrawing]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] ​  ​| ​   |    | +
-| {{wiki:​PublicEvent.gif|Public Event}}[[#​RequestingDrawing|RequestingDrawing]] ​  | [[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] ​  ​| ​   |    |+
  
-===== Public Constructors ===== +<div newline></div
-===== Protected Constructors ===== +** {{wiki:​ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) **
-==== Overlay() ==== +
-Initialize an instance of the Overlay class. +
-=== Overloads === +
-Initialize an instance of the Overlay class. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Overlay.28.29"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Overlay.28.29</a+
-=== Parameters === +
-^  Name ^  Type ^  Description ^+
  
-[[#​Protected Constructors|Go Back]] +  * //This event will be fired after Overlay ​is drawn.// 
-===== Public Methods ===== +== Remarks == 
-==== Draw(GeoCanvas) ==== +  * //For the most updated Info for this topicplease check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawn.28DrawnOverlayEventArgs.29//​
-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 methodwe reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the methodIn this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needsIf 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 Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:Void 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter is the canvas object to draw on.   |+  Description:N/A
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  ​* ​//e// 
-==== DrawPreview(GeoCanvas) ​==== +    ​* ​Type:[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] 
-This method will be used to draw preview tiles to the canvas. +    * Description:​The OverlayDrawnEventArgs passed for the event raised.
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawPreview.28GeoCanvas.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawPreview.28GeoCanvas.29</​a>​ +
-=== Return Value === +
-^ Return ​Type ^ Description ^ +
-[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]<!-- ThinkGeo.MapSuite.DesktopEdition.TilesExistingType --> ​  ​| ​The tile existing type, which indicates whether any tiles exist  |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​ProtectedMethod.gif|}} RefreshCore(GeoCanvas,​RectangleShape) **
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter is the canvas object to draw on.   |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks == 
-==== Equals(Object) ==== +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​RefreshCore.28GeoCanvas.2C_RectangleShape.29//
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Equals.28Object.29" target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Equals.28Object.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:Void 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+  Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  ​* ​//canvas// 
-==== GetHashCode() ​==== +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-=== Remarks === +    ​* ​Description:N/A
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#​GetHashCode.28.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​GetHashCode.28.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ​+
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters === +  * //extent// 
-^  Name ^  ​Type ^  ​Description ​^+    ​* ​Type:​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] 
 +    * Description:N/A
  
-<!-- System.Object --> +<div newline></div> 
-[[#Public Methods|Go Back]] +** {{wiki:ProtectedMethod.gif|}} DrawPreviewCore(GeoCanvas) **
-==== GetType() ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:/​/wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​GetType.28.29"​ target="​_blank">​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​GetType.28.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Type<!-- System.Type --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawPreviewCore.28GeoCanvas.29//​
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  * Type:[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]] 
-==== Refresh(GeoCanvas,​ RectangleShape) ​==== +  ​* ​Description:The tile existing type, which indicates whether any tiles exist.
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Refresh.28GeoCanvas.2C_RectangleShape.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Refresh.28GeoCanvas.2C_RectangleShape.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ​+
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  Description ^ +  ​* //​canvas//​ 
-| canvas ​  ​| ​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  ​| ​   +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-| extent ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<​!-- ThinkGeo.MapSuite.Core.RectangleShape --> ​  ​| ​   |+    * Description:​This parameter is the canvas object to draw on.
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +<div newline></div
-[[#Public Methods|Go Back]] +** {{wiki:​ProtectedMethod.gif|}} sBM=(GeoCanvas) **
-==== RequestDrawing() ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"​></a+
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Void 
-==== RequestDrawing(IEnumerable<​RectangleShape>,​ TimeSpan, RequestDrawingBufferTimeType) ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"></​a>​ +
-=== Return Value === +
-^ Return ​Type Description ​+
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  Description ^ +  ​* //​canvas//​ 
-| extentsToRefresh ​  | IEnumerable<​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> ​  ​| ​   | +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-| bufferTime ​  | TimeSpan<​!-- System.TimeSpan --> ​  ​| ​   +    ​* Description:​N/​A
-| bufferTimeType ​  | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<​!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> ​  ​| ​   |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +<div newline></div
-[[#Public Methods|Go Back]] +** {{wiki:​ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) **
-==== RequestDrawing(RectangleShape,​ TimeSpan, RequestDrawingBufferTimeType) ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"​></a+
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
- Name ^  Type ^  Description ^ +== Remarks ​== 
-| extentToRefresh ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<​!-- ​ThinkGeo.MapSuite.Core.RectangleShape --> ​  ​| ​   | +  ​* //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawAttributionCore.28GeoCanvas.29//
-| bufferTime ​  | TimeSpan<​!-- System.TimeSpan --> ​  ​| ​   | +
-| bufferTimeType ​  | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<​!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> ​  ​| ​   |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Void 
-==== RequestDrawing(RectangleShape,​ TimeSpan) ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"></​a>​ +
-=== Return Value === +
-^ Return ​Type Description ​+
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  Description ^ +  ​* //​canvas//​ 
-| extentToRefresh ​  ​| ​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> ​  ​| ​   | +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-| bufferTime ​  | TimeSpan<​!-- System.TimeSpan --> ​  ​| ​   |+    ​* Description:​N/​A
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +<div newline></div
-[[#Public Methods|Go Back]] +** {{wiki:​ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) **
-==== RequestDrawing(TimeSpan,​ RequestDrawingBufferTimeType) ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"​></a+
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
- Name ^  Type ^  Description ^ +== Remarks ​== 
-| bufferTime ​  | TimeSpan<​!-- System.TimeSpan --> ​  ​| ​   | +  ​* //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29//
-| bufferTimeType ​  | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<​!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> ​  ​| ​   |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Void 
-==== RequestDrawing(TimeSpan) ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"></​a>​ +
-=== Return Value === +
-^ Return ​Type Description ​+
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  Description ^ +  ​* //args// 
-| bufferTime ​  | TimeSpan<​!-- System.TimeSpan --> ​  |    ​|+    * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] 
 +    * Description:​N/​A
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +<div newline></div
-[[#Public Methods|Go Back]] +** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) **
-==== RequestDrawing(IEnumerable<RectangleShape>) ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"></​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
- Name ^  Type ^  Description ^ +== Remarks ​== 
-| extentsToRefresh ​  | IEnumerable<​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><​!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> ​  ​| ​   |+  ​* //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29//
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Void 
-==== RequestDrawing(IEnumerable<​RectangleShape>,​ TimeSpan) ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"></​a>​ +
-=== Return Value === +
-^ Return ​Type Description ​+
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  Description ^ +  ​* //args// 
-| extentsToRefresh ​  | IEnumerable<​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> ​  ​| ​   | +    * Type:[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] 
-| bufferTime ​  | TimeSpan<​!-- System.TimeSpan --> ​  ​| ​   |+    ​* Description:​N/​A
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +<div newline></div
-[[#Public Methods|Go Back]] +** {{wiki:​ProtectedMethod.gif|}} DrawException(GeoCanvas,​Exception) **
-==== RequestDrawing(RectangleShape) ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"​></a+
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //This method will draw on the canvas when an exception occurs during the drawing process.//​ 
- Name ^  Type ^  Description ^ +== Remarks ​== 
-| extentToRefresh ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<​!-- ThinkGeo.MapSuite.Core.RectangleShape --> ​  ​| ​   |+  ​* //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawException.28GeoCanvas.2C_Exception.29//
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Void 
-==== ToString() ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​ToString.28.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​ToString.28.29</​a>​ +
-=== Return Value === +
-^ Return ​Type Description ​+
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //​canvas//​ 
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
 +    * Description:This parameter is the canvas object to draw on.
  
-<!-- System.Object --> +  * //e// 
-[[#Public Methods|Go Back]] +    * Type:Exception 
-===== Protected Methods ===== +    ​* ​Description:This parameter is the exception that is occurring.
-==== DrawAttributionCore(GeoCanvas) ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawAttributionCore.28GeoCanvas.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawAttributionCore.28GeoCanvas.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ​+
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) **
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  ​| ​   |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +  * //This method is the Core method of DrawExceptionwhich can be overridden if you want to change its logicThis method will draw on the canvas when an exception occurs during drawing process.// 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-==== DrawCore(GeoCanvas) ==== +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawExceptionCore.28GeoCanvas.2C_Exception.29//​
-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.When implementing this abstract methodconsider 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 collectionIn 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 Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:Void 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter is the canvas object or a GeoImage to draw on.   |+  Description:N/A
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +  ​* ​//canvas// 
-==== DrawException(GeoCanvas,​ Exception) ​==== +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-This method will draw on the canvas when an exception occurs during the drawing process. +    ​* ​Description:This parameter is the canvas object to draw on.
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawException.28GeoCanvas.2C_Exception.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawException.28GeoCanvas.2C_Exception.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ​+
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +  * //e// 
-^  Name ^  ​Type ^  ​Description ​+    ​* ​Type:​Exception 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter is the canvas object to draw on.   | +    * Description:This parameter is the exception that is occurring.
-| e   | Exception<​!-- System.Exception --> ​  ​| ​This parameter is the exception that is occurring. ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +<div newline></div> 
-[[#​Protected Methods|Go Back]] +** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas) **
-==== DrawExceptionCore(GeoCanvas,​ Exception) ==== +
-This method is the Core method of DrawException,​ which can be overridden if you want to change its logic. This method will draw on the canvas when an exception occurs during drawing process. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:/​/wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawExceptionCore.28GeoCanvas.2C_Exception.29"​ target="​_blank">​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawExceptionCore.28GeoCanvas.2C_Exception.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //This method draws the Overlay.//​ 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter is the canvas object ​to draw on  | +  ​* //This method is the concrete wrapper for the abstract method DrawCoreThis method draws the representation of the overlay based on the extent you providedWhen implementing this abstract method, consider each feature and its column data valuesYou can use the full power of the GeoCanvas ​to do the drawingIf you need column data for a feature, be sure to override ​the GetRequiredColumnNamesCore and add the columns you need to the collectionIn 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.//
-| e   | Exception<​!-- System.Exception --> ​  | This parameter is the exception ​that is occurring  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-==== DrawPreviewCore(GeoCanvas) ==== +  * Description:N/A
-This is the core method of DrawPreview which is intended to be overridden by its concrete sub class. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawPreviewCore.28GeoCanvas.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawPreviewCore.28GeoCanvas.29</​a>​ +
-=== Return Value === +
-^ Return ​Type Description ​+
-| [[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]<​!-- ThinkGeo.MapSuite.DesktopEdition.TilesExistingType --> ​  | The tile existing type, which indicates whether any tiles exist. ​  |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  Description ^ +  ​* //​canvas//​ 
-| canvas ​  ​| ​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  ​| ​This parameter is the canvas object to draw on.   |+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
 +    * Description:​This parameter is the canvas object ​or a GeoImage ​to draw on.
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +<div newline></div> 
-[[#​Protected Methods|Go Back]] +** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingOverlayEventArgs) **
-==== Finalize() ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:/​/wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Finalize.28.29"​ target="​_blank">​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Finalize.28.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //For the most updated Info for this topic, please check it here://
  
-<!-- System.Object --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-==== MemberwiseClone() ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​MemberwiseClone.28.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​MemberwiseClone.28.29</​a>​ +
-=== Return Value === +
-^ Return ​Type Description ​+
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //​eventArgs//​ 
 +    * Type:​[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] 
 +    * Description:N/A
  
-<!-- System.Object --> +<div newline></div> 
-[[#​Protected Methods|Go Back]] +** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingOverlayEventArgs) **
-==== OnDrawing(DrawingOverlayEventArgs) ==== +
-This event will be fired before Overlay is drawn. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:/​/wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawing.28DrawingOverlayEventArgs.29"​ target="​_blank">​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawing.28DrawingOverlayEventArgs.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
- Name ^  Type ^  Description ^ +== Remarks ​== 
-| e   | [[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]<​!-- ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs --> ​  | The OverlayDrawingEventArgs passed ​for the event raised. ​  |+  ​* //For the most updated Info for this topic, please check it here://
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-==== OnDrawingAttribution(DrawingAttributionOverlayEventArgs) ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29</​a>​ +
-=== Return Value === +
-^ Return ​Type Description ​+
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  Description ^ +  ​* //​eventArgs//​ 
-| args   ​| ​[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs --> ​  ​| ​   |+    * Type:[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] 
 +    * Description:​N/​A
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +<div newline></div> 
-[[#​Protected Methods|Go Back]] +** {{wiki:ProtectedMethod.gif|}} Finalize() **
-==== OnDrawn(DrawnOverlayEventArgs) ==== +
-This event will be fired after Overlay is drawn. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:/​/wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawn.28DrawnOverlayEventArgs.29"​ target="​_blank">​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawn.28DrawnOverlayEventArgs.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
- Name ^  Type ^  Description ^ +== Remarks ​== 
-| e   | [[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]<​!-- ​ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs --> ​  | The OverlayDrawnEventArgs passed for the event raised  |+  ​* //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#​Finalize.28.29//
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-==== OnDrawnAttribution(DrawnAttributionOverlayEventArgs) ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29</​a>​ +
-=== Return Value === +
-^ Return ​Type Description ​+
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  Type ^  Description ^ +<div newline></​div>​ 
-| args   | [[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]<​!-- ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs --> ​  ​| ​   ​|+** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +  * //N/A// 
-[[#​Protected Methods|Go Back]] +== Remarks == 
-==== OnRequestedDrawing(RequestedDrawingOverlayEventArgs) ==== +  * //For the most updated Info for this topic, please check it here:http:​wiki.thinkgeo.com/wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​MemberwiseClone.28.29//​
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"><​/a> +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:Object 
-| eventArgs ​  | [[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]<​!-- ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs --> ​  ​| ​   |+  Description:N/A
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +<div newline></div
-==== OnRequestingDrawing(RequestingDrawingOverlayEventArgs) ​==== +==== Public Properties ==== 
-=== Remarks === +** {{wiki:​PublicProperty.gif|}} Attribution **
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"​></a+
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
- Name ^  Type ^  Description ^ +== Remarks ​== 
-| eventArgs ​  | [[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]<​!-- ​ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs --> ​  ​| ​   |+  ​* //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawAttributionCore.28GeoCanvas.29//​ 
 +== Return Value == 
 +  * Type:String
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +** {{wiki:PublicProperty.gif|}} Lock **
-[[#​Protected Methods|Go Back]] +
-==== RefreshCore(GeoCanvas,​ RectangleShape) ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​RefreshCore.28GeoCanvas.2C_RectangleShape.29"​ target="​_blank">​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​RefreshCore.28GeoCanvas.2C_RectangleShape.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //This property gets the OverlayLock object.// 
- Name ^  Type ^  Description ^ +== Remarks ​== 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ​ThinkGeo.MapSuite.Core.GeoCanvas --> ​  ​| ​   | +  ​* //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#​Lock//​ 
-| extent ​  ​| ​[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> ​  ​| ​   |+== Return Value == 
 +  * Type:[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]]
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +** {{wiki:PublicProperty.gif|}} IsBase **
-[[#​Protected Methods|Go Back]] +
-===== Public Properties ===== +
-==== Attribution ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawAttributionCore.28GeoCanvas.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawAttributionCore.28GeoCanvas.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-| String<​!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +  * //Gets or sets a value that indicates whether the overlay is a base overlayThe default value is false.// 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== AutoRefreshInterval ==== +  * //For the most updated Info for this topic, please check it here:http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​IsBase/​
-=== Remarks ​=== +== Return Value == 
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"><​/a> +  ​* ​Type:Boolean
-=== Return Value === +
-^ Return ​Type +
-| TimeSpan<​!-- System.TimeSpan --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ​**
-[[#Public Properties|Go Back]] +
-==== 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:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawingExceptionMode"​ target="​_blank">​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawingExceptionMode</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]<​!-- ThinkGeo.MapSuite.Core.DrawingExceptionMode --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +  * //This property gets and sets the DrawingExceptionMode used when an exception occurs during ​drawing.// 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== DrawingTime ==== +  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​DrawingExceptionMode//​ 
-This property gets the last drawing ​time for the Overlay+== Return Value == 
-=== Remarks ​=== +  ​* ​Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]
-We track the drawing time for the Overlay and report ​it back in this methodThis is useful to determine the speed of various Overlays+
-=== Return Value === +
-^ Return ​Type +
-| TimeSpan<​!-- System.TimeSpan --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +** {{wiki:PublicProperty.gif|}} IsVisible **
-[[#Public Properties|Go Back]] +
-==== 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:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​IsBase"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​IsBase</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +  * //Gets or sets a value that indicates whether the overlay ​is visible on the map.// 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== IsEmpty ==== +  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​IsVisible// 
-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+== Return Value == 
-=== Remarks ​=== +  ​* ​Type:Boolean
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​IsEmpty"​ target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​IsEmpty</​a>​ +
-=== Return Value === +
-^ Return ​Type +
-Boolean<!-- System.Boolean --> ​  |+
  
-<​!-- ​ThinkGeo.MapSuite.DesktopEdition.Overlay ​--> +** {{wiki:​PublicProperty.gif|}} Name ** 
-[[#Public Properties|Go Back]] + 
-==== IsVisible ​==== +  * //Gets or sets the name of the overlay, which can be used to represent a specific overlay.//​ 
-Gets or sets a value that indicates whether ​the overlay is visible on the map+== Remarks == 
-=== Remarks ​=== +  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Name// 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​IsVisible"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​IsVisible<​/a> +== Return Value == 
-=== Return Value === +  * Type:​String 
-Return Type ^ + 
-Boolean<​!-- System.Boolean --> ​  |+** {{wiki:​PublicProperty.gif|}} TileCache ** 
 + 
 +  * //This property gets or sets the TileCache used for the overlay.// 
 +== Remarks ​== 
 +  * //The TileCache system is always used for better performance,​ especially in the case where your application tiles can be pregenerated.//​ 
 +== Return Value == 
 +  * Type:​[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] 
 + 
 +** {{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.Overlay#​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.Overlay#​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|}} 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.Overlay#​OnDrawing.28DrawingOverlayEventArgs.29//​
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
-[[#Public Properties|Go Back]] +
-==== Lock ==== +
-This property gets the OverlayLock object. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Lock"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Lock</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]]<!-- ThinkGeo.MapSuite.DesktopEdition.OverlayLock --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +** {{wiki:​PublicEvent.gif|}} Drawn ** 
-[[#Public Properties|Go Back]] +  * //This event will be fired after the Overlay is drawn.// 
-==== Name ==== +== Remarks == 
-Gets or sets the name of the overlay, which can be used to represent a specific overlay+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawn.28DrawnOverlayEventArgs.29//
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​Name" target="​_blank">​http://​wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#​Name</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-| String<​!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
-[[#Public Properties|Go Back]] +
-==== 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:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​PreviewTileCache"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​PreviewTileCache</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]<!-- ThinkGeo.MapSuite.Core.BitmapTileCache --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +** {{wiki:​PublicEvent.gif|}} DrawingAttribution ** 
-[[#Public Properties|Go Back]] +  * //N/A// 
-==== TileCache ==== +== Remarks == 
-This property gets or sets the TileCache used for the overlay. +  * //For the most updated Info for this topicplease check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29//
-=== Remarks ​=== +
-The TileCache system is always used for better performanceespecially in the case where your application tiles can be pregenerated. +
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]<​!-- ThinkGeo.MapSuite.Core.BitmapTileCache --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
-[[#Public Properties|Go Back]] +
-===== Protected Properties ===== +
-===== Public Events ===== +
-==== Drawing ==== +
-This event will be fired before the Overlay is drawn. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawing.28DrawingOverlayEventArgs.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawing.28DrawingOverlayEventArgs.29</​a>​ +
-=== Event Arguments ​=== +
-^ Event Arguments ^ +
-[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +** {{wiki:​PublicEvent.gif|}} DrawnAttribution ** 
-[[#Public Events|Go Back]] +  * //N/A// 
-==== DrawingAttribution ==== +== Remarks == 
-=== Remarks ​=== +  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29//
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29" target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29</​a>​ +
-=== Event Arguments === +
-^ Event Arguments ^ +
-| [[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]<​!-- ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
-[[#Public Events|Go Back]] +
-==== Drawn ==== +
-This event will be fired after the Overlay is drawn. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawn.28DrawnOverlayEventArgs.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawn.28DrawnOverlayEventArgs.29</​a>​ +
-=== Event Arguments ​=== +
-^ Event Arguments ^ +
-[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +** {{wiki:​PublicEvent.gif|}} RequestedDrawing ** 
-[[#Public Events|Go Back]] +  * //N/A// 
-==== DrawnAttribution ==== +== Remarks == 
-=== Remarks ​=== +  * //For the most updated Info for this topic, please check it here://
-For the most updated Info for this topic, please check it here:<a href="​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.Overlay#​OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29</​a>​ +
-=== Event Arguments === +
-^ Event Arguments ^ +
-| [[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]<​!-- ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]
-[[#Public Events|Go Back]] +
-==== RequestedDrawing ==== +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"></​a>​ +
-=== Event Arguments ​=== +
-^ Event Arguments ^ +
-[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs --> ​  |+
  
-<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> +** {{wiki:​PublicEvent.gif|}} RequestingDrawing ​** 
-[[#Public Events|Go Back]] +  * //N/A// 
-==== RequestingDrawing ​==== +== Remarks == 
-=== Remarks ​=== +  * //For the most updated Info for this topic, please check it here://
-For the most updated Info for this topic, please check it here:<a href=""​ target="​_blank"><​/a> +
-=== Event Arguments === +
-^ Event Arguments ^ +
-| [[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]<​!-- ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs --> ​  |+
  
-<​!-- ​ThinkGeo.MapSuite.DesktopEdition.Overlay --> +Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]
-[[#Public Events|Go Back]]+
  
-__NOTOC__ 
-[[Category:​DesktopEdition]] 
-[[Category:​ThinkGeo.MapSuite.DesktopEdition]] 
-[[Category:​UpdateDocumentation]] 
  
thinkgeo.mapsuite.desktopedition.overlay.1440040130.txt.gz · Last modified: 2015/09/18 03:04 (external edit)