====== ThinkGeo.MapSuite.WebEdition.ClientCache ======

{{section>upgrade_map_suite_to_10.0}}

This class controls how the map images are cached by the browser.
===== Inheritance Hierarchy =====
  *System.Object
    ***ThinkGeo.MapSuite.WebEdition.ClientCache**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} ClientCache() **

  * //Initializes a new instance of the ClientCache class.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ClientCache.28.29//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} ClientCache(TimeSpan) **

  * //Initializes a new instance of the ClientCache class with the specified expiration time.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ClientCache.28TimeSpan.29//
== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ClientCache.28TimeSpan.2C_String.29//
== 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 ====
** {{wiki:PublicMethod.gif|}} ToJson() **

  * //Returns a JSON string containing the CacheId that will be part of the request string.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ToJson.28.29//

== Return Value ==
  * Type:String
  * Description:A JSON string that contains the CacheId.

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ToString.28.29//

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#Equals.28Object.29//

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#GetHashCode.28.29//

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#GetType.28.29//

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} Finalize() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#Finalize.28.29//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#MemberwiseClone.28.29//

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} Duration **

Gets or sets the expiration time of the images in the browser cache.
== 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.
== Return Value ==
  * Type:TimeSpan

** {{wiki:PublicProperty.gif|}} 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.
== Remarks ==
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.
== Return Value ==
  * Type:String

==== Protected Properties ====
==== Public Events ====