====== ThinkGeo.MapSuite.FormsEdition.Adapters.WorldMapKitOverlayAdapter ======

{{section>upgrade_map_suite_to_10.0}}




<!-- Class -->
This class represents an WmsOverlay which has MapSuite world map kit server integrated.
===== Inheritance Hierarchy =====
*System.Object
**[[ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter]]
***[[ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter]]
****[[ThinkGeo.MapSuite.FormsEdition.Adapters.TileOverlayAdapter]]
*****[[ThinkGeo.MapSuite.FormsEdition.Adapters.WorldMapKitOverlayAdapter]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

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

==== Public Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#CreateConcrete()|CreateConcrete]]   |    | [[ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter|MapElementAdapter]]   | Creates the concrete.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]]   |    | [[ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter|OverlayAdapter]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh()|Refresh]]   |    | [[ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter|OverlayAdapter]]   | 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}}[[#CreateConcreteCore()|CreateConcreteCore]]   |    | [[ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter|MapElementAdapter]]   | Creates the concrete core.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#RegisterCollectionSynchronization(GeoCollection<FormsItem>, GeoCollection<ConcreteItem>)|RegisterCollectionSynchronization]]   | GeoCollection<FormsItem>, GeoCollection<ConcreteItem>   | [[ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter|MapElementAdapter]]   |    |

==== Public Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:PublicProperty.gif|Public Property}}[[#ClientId|ClientId]]   | String   |    | Gets or sets a value that is your Client Id.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#Concrete|Concrete]]   | Object   | [[ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter|MapElementAdapter]]   | Gets or sets the concrete.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]]   | Boolean   | [[ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter|OverlayAdapter]]   | Gets or sets a value indicating whether this instance is visible.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#LayerType|LayerType]]   | [[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]   |    | Gets or sets the LayerType of the Overlay.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#MapType|MapType]]   | [[ThinkGeo.MapSuite.Core.WorldMapKitMapType|WorldMapKitMapType]]   |    | Gets or sets the MapType of the Overlay.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]]   | String   | [[ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter|OverlayAdapter]]   | Gets or sets the name.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#PrivateKey|PrivateKey]]   | String   |    | Gets or sets a value that is unique to your client ID, please keep your key secure.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#Projection|Projection]]   | [[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]]   |    | Gets or sets the projection for the this overlay.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#TileCache|TileCache]]   | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]   | [[ThinkGeo.MapSuite.FormsEdition.Adapters.TileOverlayAdapter|TileOverlayAdapter]]   |    |
| {{wiki:PublicProperty.gif|Public Property}}[[#TimeoutInSeconds|TimeoutInSeconds]]   | Int32   |    | Gets or sets the length of time, in seconds, before the request times out.   |

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

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

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

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

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

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter -->
[[#Public Methods|Go Back]]
==== 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() ====
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |

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

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter -->
[[#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.Adapters.OverlayAdapter -->
[[#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 =====
==== CreateConcreteCore() ====
Creates the concrete core.
=== Return Value ===
^ Return Type ^ Description ^
| Object<!-- System.Object -->   | System.Object.   |

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

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter -->
[[#Protected Methods|Go Back]]
==== 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]]
==== RegisterCollectionSynchronization(GeoCollection<FormsItem>, GeoCollection<ConcreteItem>) ====
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| formsItems   | GeoCollection<FormsItem><!-- GeoCollection{FormsItem} -->   |    |
| concreteItems   | GeoCollection<ConcreteItem><!-- GeoCollection{ConcreteItem} -->   |    |

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter -->
[[#Protected Methods|Go Back]]
===== Public Properties =====
==== ClientId ====
Gets or sets a value that is your Client Id.
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.WorldMapKitOverlayAdapter -->
[[#Public Properties|Go Back]]
==== Concrete ====
Gets or sets the concrete.
=== Return Value ===
^ Return Type ^
| Object<!-- System.Object -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter -->
[[#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.Adapters.OverlayAdapter -->
[[#Public Properties|Go Back]]
==== LayerType ====
Gets or sets the LayerType of the Overlay.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]]<!-- ThinkGeo.MapSuite.Core.WorldMapKitLayerType -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.WorldMapKitOverlayAdapter -->
[[#Public Properties|Go Back]]
==== MapType ====
Gets or sets the MapType of the Overlay.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.WorldMapKitMapType|WorldMapKitMapType]]<!-- ThinkGeo.MapSuite.Core.WorldMapKitMapType -->   |

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

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter -->
[[#Public Properties|Go Back]]
==== PrivateKey ====
Gets or sets a value that is unique to your client ID, please keep your key secure.
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.WorldMapKitOverlayAdapter -->
[[#Public Properties|Go Back]]
==== Projection ====
Gets or sets the projection for the this overlay.
=== Remarks ===
This property needs work with map unit setting on the map object. All overlay adding to the map must keep the same unit or else the map won't display properly.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]]<!-- ThinkGeo.MapSuite.Core.WorldMapKitProjection -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.WorldMapKitOverlayAdapter -->
[[#Public Properties|Go Back]]
==== TileCache ====
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]<!-- ThinkGeo.MapSuite.Core.BitmapTileCache -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.TileOverlayAdapter -->
[[#Public Properties|Go Back]]
==== TimeoutInSeconds ====
Gets or sets the length of time, in seconds, before the request times out.
=== Return Value ===
^ Return Type ^
| Int32<!-- System.Int32 -->   |

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