====== ThinkGeo.MapSuite.WebApiEdition.Overlay ======

{{section>upgrade_map_suite_to_10.0}}


===== Inheritance Hierarchy =====
  *System.Object
    ***ThinkGeo.MapSuite.WebApiEdition.Overlay**
      *[[ThinkGeo.MapSuite.WebApiEdition.LayerOverlay]]
===== Members Summary =====
==== Public Constructors ====
==== Protected Constructors ====
** {{wiki:ProtectedMethod.gif|}} Overlay() **

  * //N/A//
== Remarks ==
  * //N/A//
== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Overlay(String) **

  * //N/A//
== Remarks ==
  * //N/A//
== Parameters ==
  * //id//
    * Type:String
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//
== Parameters ==
  * //tileCache//
    * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Overlay(String,BitmapTileCache) **

  * //N/A//
== Remarks ==
  * //N/A//
== Parameters ==
  * //id//
    * Type:String
    * Description:N/A

  * //tileCache//
    * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]
    * Description:N/A

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

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

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

== Parameters ==
  * //geoCanvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * 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|}} DrawCore(GeoCanvas) **

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

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

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

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

  * //This method will draw on the canvas when an exception occurs during the drawing process.//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //geoCanvas//
    * Type:[[ThinkGeo.MapSuite.Core.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) **

  * //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//

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

== Parameters ==
  * //geoCanvas//
    * Type:[[ThinkGeo.MapSuite.Core.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|}} OnDrawing(DrawingOverlayEventArgs) **

  * //This event will be fired before Overlay is drawn.//
== Remarks ==
  * //N/A//

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

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

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

  * //This event will be fired after Overlay is drawn.//
== Remarks ==
  * //N/A//

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

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

<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|}} Id **

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

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

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

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

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

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

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

==== Protected Properties ====
==== Public Events ====
** {{wiki:PublicEvent.gif|}} Drawing **
This event raises before the overlay is drawing.
== Remarks ==
N/A

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

** {{wiki:PublicEvent.gif|}} Drawn **
This event raises after the overlay is drawn.
== Remarks ==
N/A

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