User Tools

Site Tools


thinkgeo.mapsuite.mvcedition.overlaysetting_2

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
thinkgeo.mapsuite.mvcedition.overlaysetting_2 [2015/08/20 03:08]
127.0.0.1 external edit
thinkgeo.mapsuite.mvcedition.overlaysetting_2 [2017/03/16 21:59] (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.MvcEdition.OverlaySetting`2 ======+====== 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. A setting for Overlay that contains APIs to set properties of OverlaySetting using in MVC view.
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.MvcEdition.OverlaySetting`2]]+    ​*ThinkGeo.MapSuite.MvcEdition.MvcElementSettingBase<​TOverlay,​TSetting>​ 
 +      ***ThinkGeo.MapSuite.MvcEdition.OverlaySetting<​TOverlay,​TSetting>​**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
 ==== Protected Constructors ==== ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​ProtectedMethod.gif|}} OverlaySetting`2() ​**
-{{wiki:​ProtectedMethod.gif|Protected Method}}[[#OverlaySetting`2()|OverlaySetting`2]] ​  ​| ​   |    | Initializes a new instance of the OverlaySetting class. ​  | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​OverlaySetting`2(TOverlay)|OverlaySetting`2]] ​  | TOverlay ​  ​| ​   |    |+
  
 +  * //​Initializes a new instance of the OverlaySetting class.//
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +<div newline></​div>​
 +** {{wiki:​ProtectedMethod.gif|}} OverlaySetting`2(TOverlay) **
 +
 +  * //N/A//
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //overlay//
 +    * Type:​TOverlay
 +    * Description:​N/​A
 +
 +<div newline></​div>​
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} IsVisible(Boolean) ​**
-{{wiki:​PublicMethod.gif|Public Method}}[[#​AutoRefreshInterval(TimeSpan)|AutoRefreshInterval]] ​  | TimeSpan ​  | [[ThinkGeo.MapSuite.MvcEdition.OverlaySetting|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 ​  | [[ThinkGeo.MapSuite.MvcEdition.OverlaySetting|OverlaySetting]]<​TOverlay,​TSetting> ​  | Sets id for Element property and retun the OverlaySetting ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​IsBaseOverlay(Boolean)|IsBaseOverlay]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.OverlaySetting|OverlaySetting]]<​TOverlay,​TSetting> ​  | Sets isBaseOverlay for Element property and retun the OverlaySetting ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#IsVisible(Boolean)|IsVisible]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.OverlaySetting|OverlaySetting]]<​TOverlay,​TSetting> ​  | Sets isVisible for Element property and retun the OverlaySetting ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​IsVisibleInOverlaySwitcher(Boolean)|IsVisibleInOverlaySwitcher]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.OverlaySetting|OverlaySetting]]<​TOverlay,​TSetting> ​  | Sets isVisibleInOverlaySwitcher for Element property and retun the OverlaySetting ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Name(String)|Name]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.OverlaySetting|OverlaySetting]]<​TOverlay,​TSetting> ​  | Sets name for Element property and retun the OverlaySetting ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​OnClientAutoRefreshTick(String)|OnClientAutoRefreshTick]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.OverlaySetting|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 ​  | [[ThinkGeo.MapSuite.MvcEdition.OverlaySetting|OverlaySetting]]<​TOverlay,​TSetting> ​  | Sets opacity for Element property and retun the OverlaySetting ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Protected Methods ==== +  * //Sets isVisible for Element property and retun the OverlaySetting//​ 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +== Remarks ​== 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +  * //N/A//
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Public Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+  * Type:​TSetting 
 +  * Description:​The setting of OverlaySetting itself
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * //​isVisible//​ 
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#​Element|Element]] ​  | TOverlay ​  | MvcElementSettingBase<​TOverlay,​TSetting> ​  ​| ​   |+    * Type:Boolean 
 +    * Description:​A isVisible for Element ​property
  
-==== Public Events ==== +<div newline></​div>​ 
-Name ^ Event Arguments ^ DeclaringType ^ Summary ^+** {{wiki:​PublicMethod.gif|}} ​Name(String) **
  
-===== Public Constructors ===== +  * //Sets name for Element property and retun the OverlaySetting// 
-===== Protected Constructors ===== +== Remarks ​== 
-==== OverlaySetting`2() ==== +  ​* //N/A//
-Initializes a new instance of the OverlaySetting ​class. +
-=== Parameters === +
-^  Name ^  Type ^  Description ^+
  
-[[#​Protected Constructors|Go Back]] +== Return Value == 
-==== OverlaySetting`2(TOverlay) ​==== +  ​Type:TSetting 
-=== Parameters === +  Description:The setting of OverlaySetting itself
-^  Name ^  ​Type ​ ​Description ​+
-| overlay ​  | TOverlay<​!-- TOverlay --> ​  ​| ​   |+
  
-[[#​Protected Constructors|Go Back]] +== Parameters ​== 
-===== Public Methods ===== +  * //name// 
-==== AutoRefreshInterval(TimeSpan) ==== +    * Type:​String 
-Sets timeSpan ​for Element property ​and retun the OverlaySetting +    * Description:​A imageUri ​for Element property
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| TSetting<​!-- TSetting --> ​  | The setting of OverlaySetting itself ​  |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} Opacity(Single) **
-| timeSpan ​  | TimeSpan<​!-- System.TimeSpan --> ​  | A timeSpan for Element property ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,​TSetting} --> +  * //Sets opacity for Element property and retun the OverlaySetting// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== Equals(Object) ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:TSetting 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+  Description:The setting of OverlaySetting itself
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  * //opacity// 
-==== GetHashCode() ​==== +    ​* ​Type:Single 
-=== Return Value === +    ​* Description:​A opacity for Element property
-^ Return ​Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^+** {{wiki:​PublicMethod.gif|}} IsVisibleInOverlaySwitcher(Boolean) **
  
-<!-- System.Object --> +  * //Sets isVisibleInOverlaySwitcher for Element property and retun the OverlaySetting//​ 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== GetType() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​^+  ​Type:TSetting 
 +  Description:The setting of OverlaySetting itself
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  * //​isVisibleInOverlaySwitcher//​ 
-==== Id(String) ​==== +    * Type:​Boolean 
-Sets id for Element property ​and retun the OverlaySetting +    * Description:​A isVisibleInOverlaySwitcher ​for Element property
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| TSetting<​!-- TSetting --> ​  | The setting of OverlaySetting itself ​  |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} IsBaseOverlay(Boolean) **
-| id   | String<​!-- System.String --> ​  | A id for Element property ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,​TSetting} --> +  * //Sets isBaseOverlay for Element property and retun the OverlaySetting// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== IsBaseOverlay(Boolean) ==== +  * //N/A//
-Sets isBaseOverlay for Element property and retun the OverlaySetting +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| TSetting<​!-- TSetting --> ​  | The setting of OverlaySetting itself ​  |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:TSetting 
-| isBaseOverlay ​  | Boolean<​!-- System.Boolean --> ​  | A isBaseOverlay for Element property ​  |+  Description:The setting of OverlaySetting itself
  
-<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,​TSetting} --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  * //​isBaseOverlay//​ 
-==== IsVisible(Boolean) ==== +    * Type:Boolean 
-Sets isVisible ​for Element property ​and retun the OverlaySetting +    * Description:​A isBaseOverlay ​for Element property
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| TSetting<​!-- TSetting --> ​  | The setting of OverlaySetting itself ​  |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} Id(String) **
-| isVisible ​  | Boolean<​!-- System.Boolean --> ​  | A isVisible for Element property ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,​TSetting} --> +  * //Sets id for Element property and retun the OverlaySetting// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== IsVisibleInOverlaySwitcher(Boolean) ==== +  * //N/A//
-Sets isVisibleInOverlaySwitcher ​for Element property and retun the OverlaySetting +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| TSetting<​!-- TSetting --> ​  | The setting of OverlaySetting itself ​  |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:TSetting 
-| isVisibleInOverlaySwitcher ​  | Boolean<​!-- System.Boolean --> ​  | A isVisibleInOverlaySwitcher for Element property ​  |+  Description:The setting of OverlaySetting itself
  
-<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,​TSetting} --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  * //id// 
-==== Name(String) ==== +    * Type:String 
-Sets name for Element property ​and retun the OverlaySetting +    * Description:​A id for Element property
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| TSetting<​!-- TSetting --> ​  | The setting of OverlaySetting itself ​  |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} OnClientAutoRefreshTick(String) **
-name   ​| ​String<!-- System.String --> ​  | A imageUri for Element property ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,​TSetting} --> +  * //Sets the JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed.// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== OnClientAutoRefreshTick(String) ==== +  * //N/A//
-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 === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:TSetting 
-| clientTickFunctionName ​  | String<​!-- System.String --> ​  ​| ​The JavaScript function name  |+  Description:The setting of OverlaySetting itself.
  
-<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,​TSetting} --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  * //​clientTickFunctionName//​ 
-==== Opacity(Single) ​==== +    * Type:String 
-Sets opacity for Element property and retun the OverlaySetting +    ​* ​Description:The JavaScript function name.
-=== Return Value === +
-^ Return Type ^ Description ​+
-| TSetting<​!-- TSetting --> ​  ​| ​The setting of OverlaySetting itself ​  |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} AutoRefreshInterval(TimeSpan) **
-| opacity ​  | Single<​!-- System.Single --> ​  | A opacity for Element property ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.OverlaySetting{TOverlay,​TSetting} --> +  * //Sets timeSpan for Element property and retun the OverlaySetting// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== ToString() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​^+  ​Type:TSetting 
 +  Description:The setting of OverlaySetting itself
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  * //​timeSpan//​ 
-===== Protected Methods ===== +    ​* ​Type:TimeSpan 
-==== Finalize() ==== +    ​* Description:​A timeSpan for Element property
-=== Return Value === +
-^ Return ​Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^+** {{wiki:​PublicMethod.gif|}} ToString() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-==== MemberwiseClone() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​^+  ​Type:String 
 +  Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +<div newline></​div>​ 
-===== Public Properties ===== +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-===== Protected Properties ===== +
-==== Element ==== +
-=== Return Value === +
-^ Return Type ^ +
-| TOverlay<!-- TOverlay --  ​|+
  
-<!-- MvcElementSettingBase{TOverlay,​TSetting--+  * //N/A// 
-[[#Protected ​Properties|Go Back]] +== Remarks == 
-===== Public Events ​===== +  * //N/A// 
-__NOTOC__ + 
-[[Category:MvcEdition]] +== Return Value == 
-[[Category:ThinkGeo.MapSuite.MvcEdition]] +  * Type:​Boolean 
-[[Category:UpdateDocumentation]]+  * 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|}} 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 ==== 
 +==== Protected Properties ==== 
 +** {{wiki:ProtectedProperty.gif|}} Element ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  * Type:TOverlay 
 + 
 +==== Public Events ====
  
thinkgeo.mapsuite.mvcedition.overlaysetting_2.1440040131.txt.gz · Last modified: 2015/09/21 03:35 (external edit)