thinkgeo.mapsuite.mvcedition.clientcache
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mvcedition.clientcache [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.MvcEdition.ClientCache ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | 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 ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.MvcEdition.ClientCache]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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 ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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 ==== | ||
| - | ^ 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 ^ | ||
| - | | {{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. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Duration|Duration]] | TimeSpan | | Gets or sets the expiration time of the images in the browser cache. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== ClientCache() ==== | ||
| - | Initializes a new instance of the ClientCache class. | ||
| - | === Overloads === | ||
| - | Initializes a new instance of the ClientCache class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ClientCache(TimeSpan) ==== | ||
| - | Initializes a new instance of the ClientCache class with the specified expiration time. | ||
| - | === 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. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ClientCache(TimeSpan, String) ==== | ||
| - | 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]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== FromJson(String) ==== | ||
| - | Load this object from a json string. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | jsonString | String<!-- System.String --> | a json string | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ClientCache --> | ||
| - | [[#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]] | ||
| - | ==== ToJson() ==== | ||
| - | 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ClientCache --> | ||
| - | [[#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 ===== | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ClientCache --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ | ||
| - | | TimeSpan<!-- System.TimeSpan --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ClientCache --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MvcEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.MvcEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.mvcedition.clientcache.1440040131.txt.gz ยท Last modified: 2015/09/21 03:32 (external edit)
