Differences

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

--- thinkgeo.mapsuite.desktopedition.overlay [2015/09/18 03:04]
admin
+++ thinkgeo.mapsuite.desktopedition.overlay [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.DesktopEdition.Overlay ======
+{{section>upgrade_map_suite_to_10.0}}
 Serves as the base class that defines the properties and methods shared by all types of overlays.
 ===== Inheritance Hierarchy =====
@@ Line 20: / Line 23: @@
 ** {{wiki:ProtectedMethod.gif|}} Overlay() **
-Initialize an instance of the Overlay class.
+  * //Initialize an instance of the Overlay class.//
 == Remarks ==
-N/A
+  * //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>
@@ Line 28: / Line 31: @@
 ** {{wiki:PublicMethod.gif|}} Refresh(GeoCanvas,RectangleShape) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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//
 == Return Value ==
@@ Line 48: / Line 51: @@
 ** {{wiki:PublicMethod.gif|}} DrawPreview(GeoCanvas) **
-This method will be used to draw preview tiles to the canvas.
+  * //This method will be used to draw preview tiles to the canvas.//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 64: / Line 67: @@
 ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas) **
-This method draws the Overlay.
+  * //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.
+  * //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:None
+  * Description:N/A
 == Parameters ==
@@ Line 80: / Line 83: @@
 ** {{wiki:PublicMethod.gif|}} RequestDrawing() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 92: / Line 95: @@
 ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 108: / Line 111: @@
 ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 124: / Line 127: @@
 ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 140: / Line 143: @@
 ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 160: / Line 163: @@
 ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 180: / Line 183: @@
 ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 204: / Line 207: @@
 ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 224: / Line 227: @@
 ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 248: / Line 251: @@
 ** {{wiki:PublicMethod.gif|}} ToString() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 260: / Line 263: @@
 ** {{wiki:PublicMethod.gif|}} Equals(Object) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 276: / Line 279: @@
 ** {{wiki:PublicMethod.gif|}} GetHashCode() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 288: / Line 291: @@
 ** {{wiki:PublicMethod.gif|}} GetType() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 301: / Line 304: @@
 ** {{wiki:ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) **
-This event will be fired before Overlay is drawn.
+  * //This event will be fired before Overlay is drawn.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawing.28DrawingOverlayEventArgs.29//
 == Return Value ==
@@ Line 317: / Line 320: @@
 ** {{wiki:ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) **
-This event will be fired after Overlay is drawn.
+  * //This event will be fired after Overlay is drawn.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawn.28DrawnOverlayEventArgs.29//
 == Return Value ==
@@ Line 333: / Line 336: @@
 ** {{wiki:ProtectedMethod.gif|}} RefreshCore(GeoCanvas,RectangleShape) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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//
 == Return Value ==
@@ Line 353: / Line 356: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawPreviewCore(GeoCanvas) **
-This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.
+  * //This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawPreviewCore.28GeoCanvas.29//
 == Return Value ==
@@ Line 369: / Line 372: @@
 ** {{wiki:ProtectedMethod.gif|}} sBM=(GeoCanvas) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 385: / Line 388: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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 ==
@@ Line 401: / Line 404: @@
 ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29//
 == Return Value ==
@@ Line 417: / Line 420: @@
 ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29//
 == Return Value ==
@@ Line 433: / Line 436: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) **
-This method will draw on the canvas when an exception occurs during the drawing process.
+  * //This method will draw on the canvas when an exception occurs during the drawing process.//
 == Remarks ==
-N/A
+  * //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//
 == Return Value ==
@@ Line 453: / Line 456: @@
 ** {{wiki:ProtectedMethod.gif|}} 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.
+  * //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 ==
-N/A
+  * //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//
 == Return Value ==
@@ Line 473: / Line 476: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas) **
-This method draws the Overlay.
+  * //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 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 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 method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.//
 == Return Value ==
   * Type:Void
-  * Description:None
+  * Description:N/A
 == Parameters ==
@@ Line 489: / Line 492: @@
 ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingOverlayEventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 505: / Line 508: @@
 ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingOverlayEventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
@@ Line 521: / Line 524: @@
 ** {{wiki:ProtectedMethod.gif|}} Finalize() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Finalize.28.29//
 == Return Value ==
@@ Line 533: / Line 536: @@
 ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#MemberwiseClone.28.29//
 == Return Value ==
@@ Line 546: / Line 549: @@
 ** {{wiki:PublicProperty.gif|}} Attribution **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //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
@@ Line 554: / Line 557: @@
 ** {{wiki:PublicProperty.gif|}} Lock **
-This property gets the OverlayLock object.
+  * //This property gets the OverlayLock object.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Lock//
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]]
@@ Line 562: / Line 565: @@
 ** {{wiki:PublicProperty.gif|}} IsBase **
-Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.
+  * //Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsBase//
 == Return Value ==
   * Type:Boolean
@@ Line 570: / Line 573: @@
 ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode **
-This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
+  * //This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawingExceptionMode//
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]
@@ Line 578: / Line 581: @@
 ** {{wiki:PublicProperty.gif|}} IsVisible **
-Gets or sets a value that indicates whether the overlay is visible on the map.
+  * //Gets or sets a value that indicates whether the overlay is visible on the map.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsVisible//
 == Return Value ==
   * Type:Boolean
@@ Line 586: / Line 589: @@
 ** {{wiki:PublicProperty.gif|}} Name **
-Gets or sets the name of the overlay, which can be used to represent a specific overlay.
+  * //Gets or sets the name of the overlay, which can be used to represent a specific overlay.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Name//
 == Return Value ==
   * Type:String
@@ Line 594: / Line 597: @@
 ** {{wiki:PublicProperty.gif|}} TileCache **
-This property gets or sets the TileCache used for the overlay.
+  * //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.
+  * //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]]
@@ Line 602: / Line 605: @@
 ** {{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.
+  * //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 ==
-N/A
+  * //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]]
@@ Line 610: / Line 613: @@
 ** {{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.
+  * //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 ==
-N/A
+  * //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
@@ Line 618: / Line 621: @@
 ** {{wiki:PublicProperty.gif|}} DrawingTime **
-This property gets the last drawing time for the Overlay.
+  * //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.
+  * //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
@@ Line 626: / Line 629: @@
 ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 == Return Value ==
   * Type:TimeSpan
@@ Line 635: / Line 638: @@
 ** {{wiki:ProtectedProperty.gif|}} rxM= **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
@@ Line 643: / Line 646: @@
 ==== Public Events ====
 ** {{wiki:PublicEvent.gif|}} Drawing **
-This event will be fired before the Overlay is drawn.
+  * //This event will be fired before the Overlay is drawn.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawing.28DrawingOverlayEventArgs.29//
 Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
 ** {{wiki:PublicEvent.gif|}} Drawn **
-This event will be fired after the Overlay is drawn.
+  * //This event will be fired after the Overlay is drawn.//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawn.28DrawnOverlayEventArgs.29//
 Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
 ** {{wiki:PublicEvent.gif|}} DrawingAttribution **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29//
 Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
 ** {{wiki:PublicEvent.gif|}} DrawnAttribution **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29//
 Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
 ** {{wiki:PublicEvent.gif|}} RequestedDrawing **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]
 ** {{wiki:PublicEvent.gif|}} RequestingDrawing **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //For the most updated Info for this topic, please check it here://
 Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]

User Tools

Site Tools

Differences

Page Tools