====== ThinkGeo.MapSuite.MvcEdition.OverlaySetting‹TOverlay,_TSetting› ======

{{section>upgrade_map_suite_to_10.0}}


<!-- Class -->
A setting for Overlay that contains APIs to set properties of OverlaySetting using in MVC view.
===== Inheritance Hierarchy =====
*System.Object
**[[ThinkGeo.MapSuite.MvcEdition.OverlaySetting‹TOverlay, TSetting›]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

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

==== Public Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#AutoRefreshInterval(TimeSpan)|AutoRefreshInterval]]   | TimeSpan   | OverlaySetting<TOverlay,TSetting>   | Sets timeSpan for Element property and retun the OverlaySetting   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Id(String)|Id]]   | String   | OverlaySetting<TOverlay,TSetting>   | Sets id for Element property and retun the OverlaySetting   |
| {{wiki:PublicMethod.gif|Public Method}}[[#IsBaseOverlay(Boolean)|IsBaseOverlay]]   | Boolean   | OverlaySetting<TOverlay,TSetting>   | Sets isBaseOverlay for Element property and retun the OverlaySetting   |
| {{wiki:PublicMethod.gif|Public Method}}[[#IsVisible(Boolean)|IsVisible]]   | Boolean   | OverlaySetting<TOverlay,TSetting>   | Sets isVisible for Element property and retun the OverlaySetting   |
| {{wiki:PublicMethod.gif|Public Method}}[[#IsVisibleInOverlaySwitcher(Boolean)|IsVisibleInOverlaySwitcher]]   | Boolean   | OverlaySetting<TOverlay,TSetting>   | Sets isVisibleInOverlaySwitcher for Element property and retun the OverlaySetting   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Name(String)|Name]]   | String   | OverlaySetting<TOverlay,TSetting>   | Sets name for Element property and retun the OverlaySetting   |
| {{wiki:PublicMethod.gif|Public Method}}[[#OnClientAutoRefreshTick(String)|OnClientAutoRefreshTick]]   | String   | OverlaySetting<TOverlay,TSetting>   | Sets the JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Opacity(Single)|Opacity]]   | Single   | OverlaySetting<TOverlay,TSetting>   | Sets opacity for Element property and retun the OverlaySetting   |
| {{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 ^

==== Protected Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedProperty.gif|Protected Property}}[[#Element|Element]]   | TOverlay   | MvcElementSettingBase<TOverlay,TSetting>   |    |

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

===== Public Constructors =====
===== Protected Constructors =====
==== OverlaySetting‹TOverlay, TSetting›() ====
Initializes a new instance of the OverlaySetting class.
=== Parameters ===
^  Name ^  Type ^  Description ^

[[#Protected Constructors|Go Back]]
==== OverlaySetting‹TOverlay, TSetting›(TOverlay) ====
=== Parameters ===
^  Name ^  Type ^  Description ^
| overlay   | TOverlay<!-- TOverlay -->   |    |

[[#Protected Constructors|Go Back]]
===== Public Methods =====
==== AutoRefreshInterval(TimeSpan) ====
Sets timeSpan for Element property and retun the OverlaySetting
=== Return Value ===
^ Return Type ^ Description ^
| TSetting<!-- TSetting -->   | The setting of OverlaySetting itself   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| timeSpan   | TimeSpan<!-- System.TimeSpan -->   | A timeSpan for Element property   |

<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} -->
[[#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]]
==== 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]]
==== Id(String) ====
Sets id for Element property and retun the OverlaySetting
=== Return Value ===
^ Return Type ^ Description ^
| TSetting<!-- TSetting -->   | The setting of OverlaySetting itself   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| id   | String<!-- System.String -->   | A id for Element property   |

<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} -->
[[#Public Methods|Go Back]]
==== IsBaseOverlay(Boolean) ====
Sets isBaseOverlay for Element property and retun the OverlaySetting
=== Return Value ===
^ Return Type ^ Description ^
| TSetting<!-- TSetting -->   | The setting of OverlaySetting itself   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| isBaseOverlay   | Boolean<!-- System.Boolean -->   | A isBaseOverlay for Element property   |

<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} -->
[[#Public Methods|Go Back]]
==== IsVisible(Boolean) ====
Sets isVisible for Element property and retun the OverlaySetting
=== Return Value ===
^ Return Type ^ Description ^
| TSetting<!-- TSetting -->   | The setting of OverlaySetting itself   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| isVisible   | Boolean<!-- System.Boolean -->   | A isVisible for Element property   |

<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} -->
[[#Public Methods|Go Back]]
==== IsVisibleInOverlaySwitcher(Boolean) ====
Sets isVisibleInOverlaySwitcher for Element property and retun the OverlaySetting
=== Return Value ===
^ Return Type ^ Description ^
| TSetting<!-- TSetting -->   | The setting of OverlaySetting itself   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| isVisibleInOverlaySwitcher   | Boolean<!-- System.Boolean -->   | A isVisibleInOverlaySwitcher for Element property   |

<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} -->
[[#Public Methods|Go Back]]
==== Name(String) ====
Sets name for Element property and retun the OverlaySetting
=== Return Value ===
^ Return Type ^ Description ^
| TSetting<!-- TSetting -->   | The setting of OverlaySetting itself   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| name   | String<!-- System.String -->   | A imageUri for Element property   |

<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} -->
[[#Public Methods|Go Back]]
==== OnClientAutoRefreshTick(String) ====
Sets the JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed.
=== Return Value ===
^ Return Type ^ Description ^
| TSetting<!-- TSetting -->   | The setting of OverlaySetting itself.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| clientTickFunctionName   | String<!-- System.String -->   | The JavaScript function name.   |

<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} -->
[[#Public Methods|Go Back]]
==== Opacity(Single) ====
Sets opacity for Element property and retun the OverlaySetting
=== Return Value ===
^ Return Type ^ Description ^
| TSetting<!-- TSetting -->   | The setting of OverlaySetting itself   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| opacity   | Single<!-- System.Single -->   | A opacity for Element property   |

<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,TSetting} -->
[[#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 =====
===== Protected Properties =====
==== Element ====
=== Return Value ===
^ Return Type ^
| TOverlay<!-- TOverlay -->   |

<!-- MvcElementSettingBase{TOverlay,TSetting} -->
[[#Protected Properties|Go Back]]
===== Public Events =====
__NOTOC__
[[Category:MvcEdition]]
[[Category:ThinkGeo.MapSuite.MvcEdition]]
[[Category:UpdateDocumentation]]