Table of Contents
ThinkGeo.MapSuite.MvcEdition.ClientCache
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
This class controls how the map images are cached by the browser.
Inheritance Hierarchy
- System.Object
- ThinkGeo.MapSuite.MvcEdition.ClientCache
Members Summary
Public Constructors
ClientCache()
- Initializes a new instance of the ClientCache class.
Remarks
- N/A
Parameters
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.
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.
Protected Constructors
Public Methods
ToJson()
- Returns a JSON string containing the CacheId that will be part of the request string.
Remarks
- N/A
Return Value
- Type:String
- Description:A JSON string that contains the CacheId.
Parameters
FromJson(String)
- Load this object from a json string.
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- jsonString
- Type:String
- Description:a json string
ToString()
- N/A
Remarks
- N/A
Return Value
- Type:String
- Description:N/A
Parameters
Equals(Object)
- N/A
Remarks
- N/A
Return Value
- Type:Boolean
- Description:N/A
Parameters
- obj
- Type:Object
- Description:N/A
GetHashCode()
- N/A
Remarks
- N/A
Return Value
- Type:Int32
- Description:N/A
Parameters
GetType()
- N/A
Remarks
- N/A
Return Value
- Type:Type
- Description:N/A
Parameters
Protected Methods
Finalize()
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
MemberwiseClone()
- N/A
Remarks
- N/A
Return Value
- Type:Object
- Description:N/A
Parameters
Public Properties
Duration
Gets or sets the expiration time of the images in the browser cache.
Remarks
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
- Type:TimeSpan
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 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.
Return Value
- Type:String