User Tools

Site Tools


thinkgeo.mapsuite.desktopedition.backgroundoverlay

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
thinkgeo.mapsuite.desktopedition.backgroundoverlay [2015/09/18 03:01]
admin
thinkgeo.mapsuite.desktopedition.backgroundoverlay [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay ====== ====== ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay ======
 +
 +{{section>​upgrade_map_suite_to_10.0}}
 +
 This class inherits from the Overlay abstract class. The specified overlay specifies the background information of the MapControl. This class inherits from the Overlay abstract class. The specified overlay specifies the background information of the MapControl.
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
Line 9: Line 12:
 ** {{wiki:​PublicMethod.gif|}} BackgroundOverlay() ** ** {{wiki:​PublicMethod.gif|}} BackgroundOverlay() **
  
-This is the default constructor of the class.+  * //This is the default constructor of the class.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​BackgroundOverlay.28.29/​/
 == Parameters == == Parameters ==
 <div newline></​div>​ <div newline></​div>​
Line 18: Line 21:
 ** {{wiki:​PublicMethod.gif|}} Refresh(GeoCanvas,​RectangleShape) ** ** {{wiki:​PublicMethod.gif|}} Refresh(GeoCanvas,​RectangleShape) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​Refresh.28GeoCanvas.2C_RectangleShape.29/​/
  
 == Return Value == == Return Value ==
Line 38: Line 41:
 ** {{wiki:​PublicMethod.gif|}} DrawPreview(GeoCanvas) ** ** {{wiki:​PublicMethod.gif|}} DrawPreview(GeoCanvas) **
  
-N/A+  * //This method will be used to draw preview tiles to the canvas.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​DrawPreview.28GeoCanvas.29/​/
  
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]
-  * Description:​N/A+  * Description:​The tile existing type, which indicates whether any tiles exist.
  
 == Parameters == == Parameters ==
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:​N/A+    * Description:​This parameter is the canvas object to draw on.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​PublicMethod.gif|}} Draw(GeoCanvas) ** ** {{wiki:​PublicMethod.gif|}} Draw(GeoCanvas) **
  
-N/A+  * //This method draws the Overlay.//
 == Remarks == == Remarks ==
-N/A+  * //This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the overlay based on the extent you provided. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.//
  
 == Return Value == == Return Value ==
Line 65: Line 68:
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:​N/A+    * Description:​This parameter is the canvas object to draw on.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing() ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 82: Line 85:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 98: Line 101:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>​) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>​) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 114: Line 117:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(TimeSpan) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(TimeSpan) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 130: Line 133:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(TimeSpan,​RequestDrawingBufferTimeType) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(TimeSpan,​RequestDrawingBufferTimeType) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 150: Line 153:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape,​TimeSpan) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape,​TimeSpan) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 170: Line 173:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape,​TimeSpan,​RequestDrawingBufferTimeType) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(RectangleShape,​TimeSpan,​RequestDrawingBufferTimeType) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 194: Line 197:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>,​TimeSpan) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>,​TimeSpan) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 214: Line 217:
 ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>,​TimeSpan,​RequestDrawingBufferTimeType) ** ** {{wiki:​PublicMethod.gif|}} RequestDrawing(IEnumerable<​RectangleShape>,​TimeSpan,​RequestDrawingBufferTimeType) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 238: Line 241:
 ** {{wiki:​PublicMethod.gif|}} ToString() ** ** {{wiki:​PublicMethod.gif|}} ToString() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​ToString.28.29/​/
  
 == Return Value == == Return Value ==
Line 250: Line 253:
 ** {{wiki:​PublicMethod.gif|}} Equals(Object) ** ** {{wiki:​PublicMethod.gif|}} Equals(Object) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​Equals.28Object.29/​/
  
 == Return Value == == Return Value ==
Line 266: Line 269:
 ** {{wiki:​PublicMethod.gif|}} GetHashCode() ** ** {{wiki:​PublicMethod.gif|}} GetHashCode() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​GetHashCode.28.29/​/
  
 == Return Value == == Return Value ==
Line 278: Line 281:
 ** {{wiki:​PublicMethod.gif|}} GetType() ** ** {{wiki:​PublicMethod.gif|}} GetType() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​GetType.28.29/​/
  
 == Return Value == == Return Value ==
Line 291: Line 294:
 ** {{wiki:​ProtectedMethod.gif|}} DrawCore(GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} DrawCore(GeoCanvas) **
  
-This method overrides the DrawCore logic in the Overlay base class. Draw all of the background to the image object using the parameters specified.+  * //This method overrides the DrawCore logic in the Overlay base class. Draw all of the background to the image object using the parameters specified.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​DrawCore.28GeoCanvas.29/​/
  
 == Return Value == == Return Value ==
Line 307: Line 310:
 ** {{wiki:​ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) **
  
-N/A+  * //This event will be fired before Overlay is drawn.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​OnDrawing.28DrawingOverlayEventArgs.29/​/
  
 == Return Value == == Return Value ==
Line 318: Line 321:
   * //e//   * //e//
     * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]     * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
-    * Description:​N/A+    * Description:​The OverlayDrawingEventArgs passed for the event raised.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) **
  
-N/A+  * //This event will be fired after Overlay is drawn.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​OnDrawn.28DrawnOverlayEventArgs.29/​/
  
 == Return Value == == Return Value ==
Line 334: Line 337:
   * //e//   * //e//
     * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]     * Type:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
-    * Description:​N/A+    * Description:​The OverlayDrawnEventArgs passed for the event raised.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​ProtectedMethod.gif|}} RefreshCore(GeoCanvas,​RectangleShape) ** ** {{wiki:​ProtectedMethod.gif|}} RefreshCore(GeoCanvas,​RectangleShape) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​RefreshCore.28GeoCanvas.2C_RectangleShape.29/​/
  
 == Return Value == == Return Value ==
Line 359: Line 362:
 ** {{wiki:​ProtectedMethod.gif|}} DrawPreviewCore(GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} DrawPreviewCore(GeoCanvas) **
  
-N/A+  * //This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​DrawPreviewCore.28GeoCanvas.29/​/
  
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]
-  * Description:​N/A+  * Description:​The tile existing type, which indicates whether any tiles exist.
  
 == Parameters == == Parameters ==
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:​N/A+    * Description:​This parameter is the canvas object to draw on.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​ProtectedMethod.gif|}} sBM=(GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} sBM=(GeoCanvas) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 391: Line 394:
 ** {{wiki:​ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​DrawAttributionCore.28GeoCanvas.29/​/
  
 == Return Value == == Return Value ==
Line 407: Line 410:
 ** {{wiki:​ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29/​/
  
 == Return Value == == Return Value ==
Line 423: Line 426:
 ** {{wiki:​ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29/​/
  
 == Return Value == == Return Value ==
Line 439: Line 442:
 ** {{wiki:​ProtectedMethod.gif|}} DrawException(GeoCanvas,​Exception) ** ** {{wiki:​ProtectedMethod.gif|}} DrawException(GeoCanvas,​Exception) **
  
-N/A+  * //This method will draw on the canvas when an exception occurs during the drawing process.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​DrawException.28GeoCanvas.2C_Exception.29/​/
  
 == Return Value == == Return Value ==
Line 450: Line 453:
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:​N/A+    * Description:​This parameter is the canvas object to draw on.
  
   * //e//   * //e//
     * Type:​Exception     * Type:​Exception
-    * Description:​N/A+    * Description:​This parameter is the exception that is occurring.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,​Exception) ** ** {{wiki:​ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,​Exception) **
  
-N/A+  * //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 == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​DrawExceptionCore.28GeoCanvas.2C_Exception.29/​/
  
 == Return Value == == Return Value ==
Line 470: Line 473:
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:​N/A+    * Description:​This parameter is the canvas object to draw on.
  
   * //e//   * //e//
     * Type:​Exception     * Type:​Exception
-    * Description:​N/A+    * Description:​This parameter is the exception that is occurring.
  
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingOverlayEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 495: Line 498:
 ** {{wiki:​ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingOverlayEventArgs) ** ** {{wiki:​ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingOverlayEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 == Return Value == == Return Value ==
Line 511: Line 514:
 ** {{wiki:​ProtectedMethod.gif|}} Finalize() ** ** {{wiki:​ProtectedMethod.gif|}} Finalize() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​Finalize.28.29/​/
  
 == Return Value == == Return Value ==
Line 523: Line 526:
 ** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() ** ** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​MemberwiseClone.28.29/​/
  
 == Return Value == == Return Value ==
Line 536: Line 539:
 ** {{wiki:​PublicProperty.gif|}} BackgroundBrush ** ** {{wiki:​PublicProperty.gif|}} BackgroundBrush **
  
-This property gets or sets the background brush for the MapControl.+  * //This property gets or sets the background brush for the MapControl.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​BackgroundBrush/​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]   * Type:​[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
Line 544: Line 547:
 ** {{wiki:​PublicProperty.gif|}} Attribution ** ** {{wiki:​PublicProperty.gif|}} Attribution **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​DrawAttributionCore.28GeoCanvas.29/​/
 == Return Value == == Return Value ==
   * Type:String   * Type:String
Line 552: Line 555:
 ** {{wiki:​PublicProperty.gif|}} Lock ** ** {{wiki:​PublicProperty.gif|}} Lock **
  
-N/A+  * //This property gets the OverlayLock object.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​Lock/​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]]   * Type:​[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]]
Line 560: Line 563:
 ** {{wiki:​PublicProperty.gif|}} IsBase ** ** {{wiki:​PublicProperty.gif|}} IsBase **
  
-N/A+  * //Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​IsBase/​/
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 568: Line 571:
 ** {{wiki:​PublicProperty.gif|}} DrawingExceptionMode ** ** {{wiki:​PublicProperty.gif|}} DrawingExceptionMode **
  
-N/A+  * //This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​DrawingExceptionMode/​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]   * Type:​[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]
Line 576: Line 579:
 ** {{wiki:​PublicProperty.gif|}} IsVisible ** ** {{wiki:​PublicProperty.gif|}} IsVisible **
  
-N/A+  * //Gets or sets a value that indicates whether the overlay is visible on the map.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​IsVisible/​/
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 584: Line 587:
 ** {{wiki:​PublicProperty.gif|}} Name ** ** {{wiki:​PublicProperty.gif|}} Name **
  
-N/A+  * //Gets or sets the name of the overlay, which can be used to represent a specific overlay.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​Name/​/
 == Return Value == == Return Value ==
   * Type:String   * Type:String
Line 592: Line 595:
 ** {{wiki:​PublicProperty.gif|}} TileCache ** ** {{wiki:​PublicProperty.gif|}} TileCache **
  
-N/A+  * //This property gets or sets the TileCache used for the overlay.//
 == Remarks == == Remarks ==
-N/A+  * //The TileCache system is always used for better performance,​ especially in the case where your application tiles can be pregenerated./​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]
Line 600: Line 603:
 ** {{wiki:​PublicProperty.gif|}} PreviewTileCache ** ** {{wiki:​PublicProperty.gif|}} PreviewTileCache **
  
-N/A+  * //This property gets or sets the preview tile cache system. In order for this system to work, you must be in multi-threaded mode and have the tile cache set.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​PreviewTileCache/​/
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]
Line 608: Line 611:
 ** {{wiki:​PublicProperty.gif|}} IsEmpty ** ** {{wiki:​PublicProperty.gif|}} IsEmpty **
  
-N/A+  * //This property can be overridden by its base class. If it is not overridden, its default return value will be false. If this property is empty, we can skip drawing to achieve better performance./​/
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​IsEmpty/​/
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 616: Line 619:
 ** {{wiki:​PublicProperty.gif|}} DrawingTime ** ** {{wiki:​PublicProperty.gif|}} DrawingTime **
  
-N/A+  * //This property gets the last drawing time for the Overlay.//
 == Remarks == == Remarks ==
-N/A+  * //We track the drawing time for the Overlay and report it back in this method. This is useful to determine the speed of various Overlays.//
 == Return Value == == Return Value ==
   * Type:​TimeSpan   * Type:​TimeSpan
Line 624: Line 627:
 ** {{wiki:​PublicProperty.gif|}} AutoRefreshInterval ** ** {{wiki:​PublicProperty.gif|}} AutoRefreshInterval **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
 == Return Value == == Return Value ==
   * Type:​TimeSpan   * Type:​TimeSpan
Line 633: Line 636:
 ** {{wiki:​ProtectedProperty.gif|}} rxM= ** ** {{wiki:​ProtectedProperty.gif|}} rxM= **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]   * Type:​[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
Line 641: Line 644:
 ==== Public Events ==== ==== Public Events ====
 ** {{wiki:​PublicEvent.gif|}} Drawing ** ** {{wiki:​PublicEvent.gif|}} Drawing **
-N/A+  * //This event will be fired before the Overlay is drawn.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​OnDrawing.28DrawingOverlayEventArgs.29/​/
  
 Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} Drawn ** ** {{wiki:​PublicEvent.gif|}} Drawn **
-N/A+  * //This event will be fired after the Overlay is drawn.//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​OnDrawn.28DrawnOverlayEventArgs.29/​/
  
 Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} DrawingAttribution ** ** {{wiki:​PublicEvent.gif|}} DrawingAttribution **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29/​/
  
 Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} DrawnAttribution ** ** {{wiki:​PublicEvent.gif|}} DrawnAttribution **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#​OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29/​/
  
 Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} RequestedDrawing ** ** {{wiki:​PublicEvent.gif|}} RequestedDrawing **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} RequestingDrawing ** ** {{wiki:​PublicEvent.gif|}} RequestingDrawing **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //For the most updated Info for this topic, please check it here://
  
 Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]
  
  
thinkgeo.mapsuite.desktopedition.backgroundoverlay.1442545304.txt.gz ยท Last modified: 2015/09/18 03:01 by admin