thinkgeo.mapsuite.webedition.servercache
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.servercache [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.webedition.servercache [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.ServerCache ====== | ====== ThinkGeo.MapSuite.WebEdition.ServerCache ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class controls the cachablity of the map control at the server side. | This class controls the cachablity of the map control at the server side. | ||
| - | === Remarks === | ||
| - | The <strong>ServerCache</strong> object contains information for caching map images at the server side. When you set the <strong>CacheDirectory</strong>, the server cache is automatically turned on. A map image only needs to be generated once and then saved to the folder specified by the <strong>CacheDirectory</strong>. Later, when the map image is revisited, it is retrieved from the cache folder. Using the server cache will greatly increase the responsiveness of the map, but it is only suitable for a static map. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.WebEdition.ServerCache]] | + | ***ThinkGeo.MapSuite.WebEdition.ServerCache** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ServerCache() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ServerCache()|ServerCache]] | | | Initializes a new instance of the ServerCache class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ServerCache(String)|ServerCache]] | String | | Initializes a new instance of the ServerCache class with the specified cache directory. | | + | |
| - | ==== Protected Constructors ==== | + | * //Initializes a new instance of the ServerCache 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.ServerCache#ServerCache.28.29// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ServerCache(String) ** | ||
| + | * //Initializes a new instance of the ServerCache class with the specified cache directory.// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#ServerCache.28String.29// | ||
| + | == Parameters == | ||
| + | * //cacheDirectory// | ||
| + | * Type:String | ||
| + | * Description:The directory string that indicates where the cache images are saved to. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | | {{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}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //N/A// |
| - | ^ 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.ServerCache#ToString.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}}[[#CacheDirectory|CacheDirectory]] | String | | Gets or sets a string that represents the directory of the cache folder. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CacheId|CacheId]] | String | | Gets or sets a string which is used to retrieve the cached images. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | ==== 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.ServerCache#Equals.28Object.29// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== ServerCache() ==== | + | * Type:Boolean |
| - | Initializes a new instance of the ServerCache class. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | Initializes a new instance of the ServerCache class. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#ServerCache.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#ServerCache.28.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== ServerCache(String) ==== | + | * //obj// |
| - | Initializes a new instance of the ServerCache class with the specified cache directory. | + | * Type:Object |
| - | === Overloads === | + | * Description:N/A |
| - | Initializes a new instance of the ServerCache class. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#ServerCache.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#ServerCache.28String.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | cacheDirectory | String<!-- System.String --> | The directory string that indicates where the cache images are saved to. | | + | |
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ===== Public Methods ===== | + | |
| - | ==== 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.ServerCache#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | obj | Object<!-- System.Object --> | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#GetHashCode.28.29// |
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetHashCode() ==== | + | * 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.ServerCache#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#GetHashCode.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetType() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#GetType.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.ServerCache#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#GetType.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == 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.ServerCache#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#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.ServerCache#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.ServerCache#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#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.ServerCache#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.ServerCache#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} CacheDirectory ** | ||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== CacheDirectory ==== | ||
| Gets or sets a string that represents the directory of the cache folder. | Gets or sets a string that represents the directory of the cache folder. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#CacheDirectory" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#CacheDirectory</a> | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ServerCache#CacheDirectory |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:String |
| - | | String<!-- System.String --> | | + | |
| + | ** {{wiki:PublicProperty.gif|}} CacheId ** | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.ServerCache --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== CacheId ==== | ||
| Gets or sets a string which is used to retrieve the cached images. | Gets or sets a string which is used to retrieve the cached images. | ||
| - | === Remarks === | + | == Remarks == |
| - | The <strong>CacheId</strong> is actually the name of a sub-folder of the cache folder to which images with the same CacheId are saved. When you set the same CacheId in different pages, the map images of these pages will be saved and retrieved from the same folder. Thus you can share cache images between pages. | + | The <strong>CacheId</strong> is actually the name of a sub-folder of the cache folder to which images with the same CacheId are saved. When you set the same CacheId in different pages, the map images of these pages will be saved and retrieved from the same folder. Thus you can share cache images between pages. |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:String |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.ServerCache --> | + | ==== Protected Properties ==== |
| - | [[#Public Properties|Go Back]] | + | ==== Public Events ==== |
| - | ===== Protected Properties ===== | + | |
| - | ===== Public Events ===== | + | |
| - | __NOTOC__ | + | |
| - | [[Category:WebEdition]] | + | |
| - | [[Category:ThinkGeo.MapSuite.WebEdition]] | + | |
| - | [[Category:UpdateDocumentation]] | + | |
thinkgeo.mapsuite.webedition.servercache.1440040135.txt.gz · Last modified: 2015/09/18 03:09 (external edit)