thinkgeo.mapsuite.webedition.clientcache
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.clientcache [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.webedition.clientcache [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.ClientCache ====== | ====== ThinkGeo.MapSuite.WebEdition.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.WebEdition.ClientCache]] | + | ***ThinkGeo.MapSuite.WebEdition.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 == |
| + | * //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 ==== | ==== 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}}[[#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 | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ToJson.28.29// |
| - | | {{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|}} ToString() ** | ||
| - | ==== Public Events ==== | + | * //N/A// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == 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// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== ClientCache() ==== | + | * Type:String |
| - | Initializes a new instance of the ClientCache class. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | Initializes a new instance of the ClientCache class. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ClientCache.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ClientCache.28.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== ClientCache(TimeSpan) ==== | + | <div newline></div> |
| - | Initializes a new instance of the ClientCache class with the specified expiration time. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | === Overloads === | + | |
| - | Initializes a new instance of the ClientCache class. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ClientCache.28TimeSpan.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ClientCache.28TimeSpan.29</a> | + | |
| - | === 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]] | + | * //N/A// |
| - | ==== ClientCache(TimeSpan, String) ==== | + | == Remarks == |
| - | Initializes a new instance of the ClientCache class with the specified expiration time and cacheId string. | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#Equals.28Object.29// |
| - | === Overloads === | + | |
| - | Initializes a new instance of the ClientCache class. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ClientCache.28TimeSpan.2C_String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ClientCache.28TimeSpan.2C_String.29</a> | + | |
| - | === 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]] | + | == Return Value == |
| - | ===== Protected Constructors ===== | + | * Type:Boolean |
| - | ===== Public Methods ===== | + | * Description:N/A |
| - | ==== Equals(Object) ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //obj// |
| - | | obj | Object<!-- System.Object --> | | | + | * Type:Object |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ==== GetHashCode() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#GetHashCode.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == 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// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetType() ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#GetType.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== ToJson() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#GetType.28.29// |
| - | 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ToJson.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ToJson.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | A JSON string that contains the CacheId. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.ClientCache --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== ToString() ==== | + | ==== Protected Methods ==== |
| - | === Remarks === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#ToString.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == 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// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ===== Protected Methods ===== | + | * Description:N/A |
| - | ==== Finalize() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#Finalize.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== MemberwiseClone() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#MemberwiseClone.28.29// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ClientCache#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ===== Public Properties ===== | + | ==== Public Properties ==== |
| - | ==== CacheId ==== | + | ** {{wiki:PublicProperty.gif|}} Duration ** |
| - | 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.WebEdition.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 <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 Value == |
| - | ^ Return Type ^ | + | * Type:TimeSpan |
| - | | TimeSpan<!-- System.TimeSpan --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.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 <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. |
| - | [[Category:WebEdition]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.WebEdition]] | + | * Type:String |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.webedition.clientcache.1440040135.txt.gz · Last modified: 2015/09/18 03:07 (external edit)