====== ThinkGeo.MapSuite.FormsEdition.Overlay ======

{{section>upgrade_map_suite_to_10.0}}




<!-- Class -->
This class is the base class of all overlays in this overlay system.
=== Remarks ===
The <strong>Overlay</strong> has the similar concept as the layer. Different types of overlays stack over each other to form a map. An overlay object is responsible for getting the configuration infomation from the user.

Usually an overlay represents an image with transparent background that is laid upon other overlay such as <strong>LayerOverlay</strong>, <strong>WmsOverlay</strong>. While the <strong>MarkerOverlay</strong> will not be rendered as an image, it is actually represents a control that holds bunch of marker images on the map.
===== Inheritance Hierarchy =====
*System.Object
**[[ThinkGeo.MapSuite.FormsEdition.Overlay]]
***[[ThinkGeo.MapSuite.FormsEdition.AdornmentOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.BingMapsOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.EditInteractiveOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.GoogleMapsOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.InteractiveOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.LayerOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.MarkerOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.OpenStreetMapOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.Overlay‹T›]]
***[[ThinkGeo.MapSuite.FormsEdition.PopupOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.TileOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.TileOverlay‹T›]]
***[[ThinkGeo.MapSuite.FormsEdition.TrackInteractiveOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.WmsOverlay]]
***[[ThinkGeo.MapSuite.FormsEdition.WorldMapKitOverlay]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

==== Protected Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Overlay()|Overlay]]   |    |    | Initializes a new instance of the class.   |

==== Public Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]]   |    |    | Gets the bounding box.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh()|Refresh]]   |    |    | This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |

==== Protected Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |

==== Public Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:PublicProperty.gif|Public Property}}[[#Adapter|Adapter]]   | [[ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter|MapElementAdapter]]   |    | Gets the adapter.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]]   | Boolean   |    | Gets or sets a value indicating whether this instance is visible.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]]   | String   |    | Gets or sets the name.   |

==== Protected Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^

==== Public Events ====
^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^

===== Public Constructors =====
===== Protected Constructors =====
==== Overlay() ====
Initializes a new instance of the class.
=== Parameters ===
^  Name ^  Type ^  Description ^

[[#Protected Constructors|Go Back]]
===== Public Methods =====
==== Equals(Object) ====
=== Return Value ===
^ Return Type ^ Description ^
| Boolean<!-- System.Boolean -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| obj   | Object<!-- System.Object -->   |    |

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetBoundingBox() ====
Gets the bounding box.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | RectangleShape.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.FormsEdition.Overlay -->
[[#Public Methods|Go Back]]
==== GetHashCode() ====
=== Return Value ===
^ Return Type ^ Description ^
| Int32<!-- System.Int32 -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetType() ====
=== Return Value ===
^ Return Type ^ Description ^
| Type<!-- System.Type -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== Refresh() ====
This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.
=== Remarks ===
The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.FormsEdition.Overlay -->
[[#Public Methods|Go Back]]
==== ToString() ====
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
===== Protected Methods =====
==== Finalize() ====
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
==== MemberwiseClone() ====
=== Return Value ===
^ Return Type ^ Description ^
| Object<!-- System.Object -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
===== Public Properties =====
==== Adapter ====
Gets the adapter.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter|MapElementAdapter]]<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Overlay -->
[[#Public Properties|Go Back]]
==== IsVisible ====
Gets or sets a value indicating whether this instance is visible.
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Overlay -->
[[#Public Properties|Go Back]]
==== Name ====
Gets or sets the name.
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Overlay -->
[[#Public Properties|Go Back]]
===== Protected Properties =====
===== Public Events =====
__NOTOC__
[[Category:MapSuiteFormsEdition]]
[[Category:ThinkGeo.MapSuite.FormsEdition]]
[[Category:UpdateDocumentation]]