This class inherits from the Overlay abstract class. The specified overlay specifies the background information of the MapControl.

• System.Object
  • ThinkGeo.MapSuite.DesktopEdition.Overlay
    • ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay

BackgroundOverlay()

• This is the default constructor of the class.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#BackgroundOverlay.28.29

Refresh(GeoCanvas,RectangleShape)

• 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

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• extent
  • Type:RectangleShape
  • Description:N/A

DrawPreview(GeoCanvas)

• This method will be used to draw preview tiles to the canvas.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawPreview.28GeoCanvas.29

• Type:TilesExistingType
• Description:The tile existing type, which indicates whether any tiles exist.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object to draw on.

Draw(GeoCanvas)

• This method draws the Overlay.

• 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.

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object to draw on.

RequestDrawing()

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

RequestDrawing(RectangleShape)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• extentsToRefresh
  • Type:IEnumerable<RectangleShape>
  • Description:N/A

RequestDrawing(TimeSpan)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• extentsToRefresh
  • Type:IEnumerable<RectangleShape>
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• extentsToRefresh
  • Type:IEnumerable<RectangleShape>
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

ToString()

• 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

• Type:String
• Description:N/A

Equals(Object)

• 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

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

• 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

• Type:Int32
• Description:N/A

GetType()

• 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

• Type:Type
• Description:N/A

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.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawCore.28GeoCanvas.29

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:This parameter specifies the target canvas on which to draw the current AdormentOverlay.

OnDrawing(DrawingOverlayEventArgs)

• This event will be fired before Overlay is drawn.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawing.28DrawingOverlayEventArgs.29

• Type:Void
• Description:N/A

• e
  • Type:DrawingOverlayEventArgs
  • Description:The OverlayDrawingEventArgs passed for the event raised.

OnDrawn(DrawnOverlayEventArgs)

• This event will be fired after Overlay is drawn.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawn.28DrawnOverlayEventArgs.29

• Type:Void
• Description:N/A

• e
  • Type:DrawnOverlayEventArgs
  • Description:The OverlayDrawnEventArgs passed for the event raised.

RefreshCore(GeoCanvas,RectangleShape)

• 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

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• extent
  • Type:RectangleShape
  • Description:N/A

DrawPreviewCore(GeoCanvas)

• This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawPreviewCore.28GeoCanvas.29

• Type:TilesExistingType
• Description:The tile existing type, which indicates whether any tiles exist.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object to draw on.

sBM=(GeoCanvas)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

DrawAttributionCore(GeoCanvas)

• 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

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

• 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

• Type:Void
• Description:N/A

• args
  • Type:DrawingAttributionOverlayEventArgs
  • Description:N/A

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

• 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

• Type:Void
• Description:N/A

• args
  • Type:DrawnAttributionOverlayEventArgs
  • Description:N/A

DrawException(GeoCanvas,Exception)

• This method will draw on the canvas when an exception occurs during the drawing process.

• 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

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object to draw on.

• e
  • Type:Exception
  • Description:This parameter is the exception that is occurring.

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.

• 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

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object to draw on.

• e
  • Type:Exception
  • Description:This parameter is the exception that is occurring.

OnRequestedDrawing(RequestedDrawingOverlayEventArgs)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestedDrawingOverlayEventArgs
  • Description:N/A

OnRequestingDrawing(RequestingDrawingOverlayEventArgs)

• N/A

• For the most updated Info for this topic, please check it here:

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestingDrawingOverlayEventArgs
  • Description:N/A

Finalize()

• 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

• Type:Void
• Description:N/A

MemberwiseClone()

• 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

• Type:Object
• Description:N/A

BackgroundBrush

• This property gets or sets the background brush for the MapControl.

• For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#BackgroundBrush// == Return Value == * Type:GeoBrush Attribution * N/A == Remarks == * For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawAttributionCore.28GeoCanvas.29//

• Type:String

Lock

• This property gets the OverlayLock object.

• For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#Lock// == Return Value == * Type:OverlayLock 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#IsBase//

• Type:Boolean

DrawingExceptionMode

• This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.

• For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawingExceptionMode// == Return Value == * Type:DrawingExceptionMode IsVisible * Gets or sets a value that indicates whether the overlay is visible on the map. == Remarks == * For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#IsVisible//

• Type:Boolean

Name

• 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.BackgroundOverlay#Name// == Return Value == * Type:String 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:BitmapTileCache 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.BackgroundOverlay#PreviewTileCache//

• Type:BitmapTileCache

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.

• For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#IsEmpty// == Return Value == * Type:Boolean 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 AutoRefreshInterval * N/A == Remarks == * For the most updated Info for this topic, please check it here: == Return Value == * Type:TimeSpan ==== Protected Properties ==== rxM= * N/A == Remarks == * N/A == Return Value == * Type:BitmapTile ==== 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawing.28DrawingOverlayEventArgs.29//

Event Arguments:DrawingOverlayEventArgs

Drawn

• This event will be fired after the Overlay is drawn.

• 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:DrawnOverlayEventArgs DrawingAttribution * N/A == Remarks == * 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:DrawingAttributionOverlayEventArgs

DrawnAttribution

• 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:DrawnAttributionOverlayEventArgs RequestedDrawing * N/A == Remarks == * For the most updated Info for this topic, please check it here: Event Arguments:RequestedDrawingOverlayEventArgs RequestingDrawing * N/A == Remarks == * For the most updated Info for this topic, please check it here: Event Arguments:RequestingDrawingOverlayEventArgs