====== ThinkGeo.MapSuite.WinForms.Overlay ======


===== Inheritance Hierarchy =====
  *System.Object
    ***ThinkGeo.MapSuite.WinForms.Overlay**
      *[[ThinkGeo.MapSuite.WinForms.InteractiveOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.AdornmentOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.BackgroundOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.BingMapsOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.GoogleMapsOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.LayerOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.MarkerOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.OpenStreetMapOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.TiledWmsOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.WmtsOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.WorldStreetsAndImageryOverlay]]
      *[[ThinkGeo.MapSuite.WinForms.WorldMapKitWmsDesktopOverlay]]
===== Members Summary =====
==== Public Constructors ====
==== Protected Constructors ====
** {{wiki:ProtectedMethod.gif|}} Overlay() **

  * //Initialize an instance of the Overlay class.//
== Remarks ==
  * //N/A//
== Parameters ==
<div newline></div>
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} Refresh(GeoCanvas,RectangleShape) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //extent//
    * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} DrawPreview(GeoCanvas) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WinForms.TilesExistingType|TilesExistingType]]
  * Description:The tile existing type, which indicates whether any tiles exist.

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:This parameter is the canvas object to draw on.

<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas) **

  * //N/A//
== 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:None

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:This parameter is the canvas object to draw on.

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentToRefresh//
    * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentsToRefresh//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) **

  * //N/A//
== Remarks ==
  * //N/A//

== 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 ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Layers.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentToRefresh//
    * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]
    * Description:N/A

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

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentToRefresh//
    * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]
    * Description:N/A

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

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Layers.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentsToRefresh//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.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 ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //extentsToRefresh//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]>
    * Description:N/A

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

  * //bufferTimeType//
    * Type:[[ThinkGeo.MapSuite.Layers.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
===== Protected Methods =====
** {{wiki:ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.WinForms.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
    * Description:The OverlayDrawingEventArgs passed for the event raised.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.WinForms.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
    * Description:The OverlayDrawnEventArgs passed for the event raised.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} RefreshCore(GeoCanvas,RectangleShape) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //extent//
    * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawPreviewCore(GeoCanvas) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WinForms.TilesExistingType|TilesExistingType]]
  * Description:The tile existing type, which indicates whether any tiles exist.

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:This parameter is the canvas object to draw on.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawAttribution(GeoCanvas) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //args//
    * Type:[[ThinkGeo.MapSuite.WinForms.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //args//
    * Type:[[ThinkGeo.MapSuite.WinForms.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:This parameter is the canvas object to draw on.

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

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:This parameter is the canvas object to draw on.

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

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas) **

  * //N/A//
== 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.//

== Return Value ==
  * Type:Void
  * Description:None

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]]
    * Description:This parameter is the canvas object or a GeoImage to draw on.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingOverlayEventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //eventArgs//
    * Type:[[ThinkGeo.MapSuite.WinForms.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingOverlayEventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //eventArgs//
    * Type:[[ThinkGeo.MapSuite.WinForms.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Finalize() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} Attribution **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} Lock **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.WinForms.OverlayLock|OverlayLock]]

** {{wiki:PublicProperty.gif|}} IsBase **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} DrawingExceptionMode **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Drawing.DrawingExceptionMode|DrawingExceptionMode]]

** {{wiki:PublicProperty.gif|}} IsVisible **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} Name **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} TileCache **

  * //N/A//
== 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.Layers.BitmapTileCache|BitmapTileCache]]

** {{wiki:PublicProperty.gif|}} PreviewTileCache **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Layers.BitmapTileCache|BitmapTileCache]]

** {{wiki:PublicProperty.gif|}} IsEmpty **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} DrawingTime **

  * //N/A//
== 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 ==
  * //N/A//
== Return Value ==
  * Type:TimeSpan

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} ScreenBitmapTile **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Layers.BitmapTile|BitmapTile]]

==== Public Events ====
** {{wiki:PublicEvent.gif|}} Drawing **
  * //N/A//
== Remarks ==
  * //N/A//

Event Arguments:[[ThinkGeo.MapSuite.WinForms.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]

** {{wiki:PublicEvent.gif|}} Drawn **
  * //N/A//
== Remarks ==
  * //N/A//

Event Arguments:[[ThinkGeo.MapSuite.WinForms.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]

** {{wiki:PublicEvent.gif|}} DrawingAttribution **
  * //N/A//
== Remarks ==
  * //N/A//

Event Arguments:[[ThinkGeo.MapSuite.WinForms.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]

** {{wiki:PublicEvent.gif|}} DrawnAttribution **
  * //N/A//
== Remarks ==
  * //N/A//

Event Arguments:[[ThinkGeo.MapSuite.WinForms.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]

** {{wiki:PublicEvent.gif|}} RequestedDrawing **
  * //N/A//
== Remarks ==
  * //N/A//

Event Arguments:[[ThinkGeo.MapSuite.WinForms.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]

** {{wiki:PublicEvent.gif|}} RequestingDrawing **
  * //N/A//
== Remarks ==
  * //N/A//

Event Arguments:[[ThinkGeo.MapSuite.WinForms.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]