User Tools

Site Tools

Trace:
thinkgeo.mapsuite.mvcedition.clientcache

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.mvcedition.clientcache [2015/08/20 03:08]
127.0.0.1 external edit 		thinkgeo.mapsuite.mvcedition.clientcache [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.MvcEdition.ClientCache ====== ====== ThinkGeo.MapSuite.MvcEdition.ClientCache ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 This class controls how the map images are cached by the browser. This class controls how the map images are cached by the browser.
-=== Remarks === 
-The ClientCache class controls whether the map images will be cached by the browser. Setting the <​strong>​CacheId</​strong>​ will enable the browser to cache the map images. 
- 
-The <​strong>​CacheId</​strong>​ string will be appended to the URL of the image. The browser uses the URL as the key to retrieve a cached image. Thus, you can make the browser cache different images by setting the <​strong>​CacheId</​strong>​ to different values. For example, you can set a different CacheId for requests with different parameters and the browser will cache the different images for those requests. 
- 
-The <​strong>​Duration</​strong>​ defines the length of time that the images will remain in the browser cache. After that time, the image will then be requested from the server. 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.MvcEdition.ClientCache]]+    ***ThinkGeo.MapSuite.MvcEdition.ClientCache**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} ClientCache() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#ClientCache()|ClientCache]] ​  ​| ​   |    | Initializes a new instance of the ClientCache class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ClientCache(TimeSpan)|ClientCache]] ​  | TimeSpan ​  ​| ​   | Initializes a new instance of the ClientCache class with the specified expiration time.   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ClientCache(TimeSpan,​ String)|ClientCache]] ​  | TimeSpan, String ​  ​| ​   | Initializes a new instance of the ClientCache class with the specified expiration time and cacheId string. ​  |+
  
-==== Protected Constructors ​==== +  * //​Initializes a new instance of the ClientCache class.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //N/A// 
 +== Parameters ​== 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} ClientCache(TimeSpan) **
  
 +  * //​Initializes a new instance of the ClientCache class with the specified expiration time.//
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //​duration//​
 +    * Type:​TimeSpan
 +    * Description:​The amount of the time that the cached images are to remain in the browser cache.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} ClientCache(TimeSpan,​String) **
 +
 +  * //​Initializes a new instance of the ClientCache class with the specified expiration time and cacheId string.//
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //​duration//​
 +    * Type:​TimeSpan
 +    * Description:​The amount of the time that the cached images are to remain in the browser cache.
 +
 +  * //cacheId//
 +    * Type:String
 +    * Description:​A string that the browser uses to retrieve a cached image.
 +
 +<div newline></​div>​
 +==== Protected Constructors ====
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} ToJson() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​FromJson(String)|FromJson]] ​  | String ​  ​| ​   | Load this object from a json string. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#ToJson()|ToJson]] ​  ​| ​   |    | Returns a JSON string containing the CacheId that will be part of the request string. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Protected Methods ==== +  * //Returns a JSON string containing the CacheId that will be part of the request string.// 
-^ 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:String 
-| {{wiki:PublicProperty.gif|Public Property}}[[#​CacheId|CacheId]] ​  | String ​  ​| ​   | Gets or sets a string that enables ​the browser to cache images, and which is also part of the key for the browser to distinguish between each cached image. ​  | +  * Description:A JSON string that contains ​the CacheId.
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Duration|Duration]] ​  | TimeSpan ​  ​| ​   | Gets or sets the expiration time of the images in the browser cache.   |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} FromJson(String) **
  
-==== Public Events ==== +  * //Load this object from a json string.// 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //N/A//
  
-===== Public Constructors ===== +== Return Value == 
-==== ClientCache() ==== +  ​* Type:Void 
-Initializes a new instance of the ClientCache class. +  * Description:N/A
-=== Overloads === +
-Initializes a new instance of the ClientCache class. +
-=== Parameters === +
-^  Name ^  ​Type ​^  ​Description ​^+
  
-[[#Public Constructors|Go Back]] +== Parameters == 
-==== ClientCache(TimeSpan) ==== +  ​* //​jsonString//​ 
-Initializes a new instance of the ClientCache class with the specified expiration time. +    * Type:String 
-=== Overloads === +    * Description:a json string
-Initializes a new instance of the ClientCache class. +
-=== Parameters ​=== +
-^  Name ^  ​Type ​^  ​Description ​^ +
-| duration ​  | TimeSpan<​!-- System.TimeSpan --> ​  | The amount of the time that the cached images are to remain in the browser cache. ​  |+
  
-[[#Public Constructors|Go Back]] +<div newline></div> 
-==== ClientCache(TimeSpan,​ String) ==== +** {{wiki:​PublicMethod.gif|}} ToString() **
-Initializes a new instance of the ClientCache class with the specified expiration time and cacheId string. +
-=== Overloads === +
-Initializes a new instance of the ClientCache class. +
-=== Parameters === +
-^  Name ^  Type ^  Description ^ +
-| duration ​  | TimeSpan<!-- System.TimeSpan -->   | The amount of the time that the cached images are to remain in the browser cache. ​  | +
-| cacheId ​  | String<!-- System.String -->   | A string that the browser uses to retrieve a cached image.   ​|+
  
-[[#Public Constructors|Go Back]] +  * //N/A// 
-===== Protected Constructors ===== +== Remarks ​== 
-===== Public Methods ===== +  * //N/A//
-==== Equals(Object) ==== +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^ +  ​* Type:String 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== FromJson(String) ​==== +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-Load this object from a json string. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| jsonString ​  | String<​!-- System.String --> ​  | a json string ​  |+  ​* //N/A//
  
-<!-- ThinkGeo.MapSuite.MvcEdition.ClientCache --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Boolean 
-==== GetHashCode() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //obj// 
 +    * Type:Object 
 +    * Description:N/A
  
-<!-- System.Object --> +<div newline></​div> 
-[[#Public Methods|Go Back]] +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-==== GetType() ==== +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Int32 
-==== ToJson() ==== +  * Description:N/A
-Returns a JSON string containing the CacheId that will be part of the request string. +
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| String<​!-- System.String --> ​  ​| ​A JSON string that contains the CacheId. ​  |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} GetType() **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.ClientCache --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== ToString() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Type 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters == 
-[[#Public Methods|Go Back]] +<div newline></​div> 
-===== Protected Methods ​===== +==== Protected Methods ==== 
-==== Finalize() ​==== +** {{wiki:​ProtectedMethod.gif|}} ​Finalize() ​**
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-==== MemberwiseClone() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-===== Public Properties ===== +  * //N/A// 
-==== CacheId ==== + 
-Gets or sets a string that enables the browser to cache images, and which is also part of the key for the browser to distinguish between each cached image. +== Return Value == 
-=== Remarks === +  * Type:​Object 
-Setting the <strong>CacheId</strong> will enable the browser to cache the map images. The <​strong>​CacheId</​strong>​ string will also be appended to the URL of the image. The browser uses the URL as the key to retrieve a cached image; thus, you can make the browser cache different images by setting the <​strong>​CacheId</​strong>​ to different values. For example, you can set a different CacheId for requests with different parameters and the browser will cache the different images for those requests. +  * Description:​N/​A 
-=== Return Value === + 
-^ Return Type ^ +== Parameters ​== 
-| String<​!-- System.String --> ​  |+<div newline></div> 
 +==== Public Properties ==== 
 +** {{wiki:​PublicProperty.gif|}} Duration **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.ClientCache --> 
-[[#Public Properties|Go Back]] 
-==== Duration ==== 
 Gets or sets the expiration time of the images in the browser cache. Gets or sets the expiration time of the images in the browser cache.
-=== Remarks ​=== +== Remarks == 
-The <​strong>​Duration</​strong> ​indicates the length of time that images will remain in the browser cache before expiring. The default value is 7 day. +The Duration indicates the length of time that images will remain in the browser cache before expiring. The default value is 7 day. 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:TimeSpan
-| TimeSpan<​!-- System.TimeSpan ​--> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.ClientCache --> +** {{wiki:​PublicProperty.gif|}} CacheId ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +Gets or sets a string that enables the browser to cache images, and which is also part of the key for the browser to distinguish between each cached image. 
-===== Public Events ===== +== Remarks == 
-__NOTOC__ +Setting the CacheId will enable the browser to cache the map images. The CacheId string will also be appended to the URL of the image. The browser uses the URL as the key to retrieve a cached image; thus, you can make the browser cache different images by setting the CacheId to different values. For example, you can set a different CacheId for requests with different parameters and the browser will cache the different images for those requests. 
-[[Category:​MvcEdition]] +== Return Value == 
-[[Category:​ThinkGeo.MapSuite.MvcEdition]] +  * Type:​String 
-[[Category:​UpdateDocumentation]]+ 
 +==== Protected Properties ==== 
 +==== Public Events ====
  
thinkgeo.mapsuite.mvcedition.clientcache.1440040131.txt.gz · Last modified: 2015/09/21 03:32 (external edit)

Page Tools