====== ThinkGeo.MapSuite.FormsEdition.Adapters.WmsOverlayAdapter ======

{{section>upgrade_map_suite_to_10.0}}




<!-- Class -->
Represents an overlay object that gets map images from the WMS server you specify.
=== Remarks ===
The <strong>WmsOverlay</strong> gets images from one or more WMS servers that you specify. Usually, you add a WMS server URI to the <strong>ServerUris</strong> collection and the <strong>WmsOverlay</strong> will make a request to that WMS server to get its tile images.

You can also add multiple WMS server URIs to the ServerUris collection. The WmsOverlay will randomly send requests to those WMS servers in a concurrent fashion. This means that the tile images can come from different WMS servers, thus greatly enhancing performance. <strong>Do not</strong> add URIs of differently-configured WMS servers to the ServerUris collection.
===== Inheritance Hierarchy =====
*System.Object
**[[ThinkGeo.MapSuite.FormsEdition.Adapters.MapElementAdapter]]
***[[ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter]]
****[[ThinkGeo.MapSuite.FormsEdition.Adapters.WmsOverlayAdapter]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

==== Protected Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#WmsOverlayAdapter()|WmsOverlayAdapter]]   |    |    | 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}}[[#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}}[[#Name|Name]]   | String   | [[ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter|OverlayAdapter]]   | Gets or sets the name.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#Parameters|Parameters]]   | Dictionary<String,String>   |    | Gets a dictionary whose items will be passed to the WMS server as parameters.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ServerUris|ServerUris]]   | Collection<Uri>   |    | Gets a collection of URIs that specifies the locations of the WMS servers.   |

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

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

===== Public Constructors =====
===== Protected Constructors =====
==== WmsOverlayAdapter() ====
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 =====
==== 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]]
==== Name ====
Gets or sets the name.
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.OverlayAdapter -->
[[#Public Properties|Go Back]]
==== Parameters ====
Gets a dictionary whose items will be passed to the WMS server as parameters.
=== Return Value ===
^ Return Type ^
| Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} -->   |

<!-- ThinkGeo.MapSuite.FormsEdition.Adapters.WmsOverlayAdapter -->
[[#Public Properties|Go Back]]
==== ServerUris ====
Gets a collection of URIs that specifies the locations of the WMS servers.
=== Return Value ===
^ Return Type ^
| Collection<Uri><!-- System.Collections.ObjectModel.Collection{System.Uri} -->   |

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