====== ThinkGeo.MapSuite.Core.FileBitmapTileCache ======

{{section>upgrade_map_suite_to_10.0}}

This class is a concrete class inherits from BitmapTileCache. In this class, the tiles will be saved in disk and can be viewed very conveniently.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.Core.TileCache
      *ThinkGeo.MapSuite.Core.BitmapTileCache
        ***ThinkGeo.MapSuite.Core.FileBitmapTileCache**
          *[[ThinkGeo.MapSuite.Core.EncryptedFileBitmapTileCache]]
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} FileBitmapTileCache() **

  * //This is the default constructor.//
== Remarks ==
  * //If you use this constructor, you have to set the properties manually.//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} FileBitmapTileCache(String) **

  * //This is the overloads constructor.//
== Remarks ==
  * //If you use this constructor, the other properties are set with default values.//
== Parameters ==
  * //cacheDirectory//
    * Type:String
    * Description:This parameter specifies the cache directory of the tile cache.

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

  * //This is the overloads constructor.//
== Remarks ==
  * //If you use this constructor, the other properties are set with default values.//
== Parameters ==
  * //cacheDirectory//
    * Type:String
    * Description:This parameter specifies the cache directory of the tile cache.

  * //cacheId//
    * Type:String
    * Description:This parameter specifies the cache id of the tile cache.

<div newline></div>
** {{wiki:PublicMethod.gif|}} FileBitmapTileCache(String,String,TileImageFormat,TileMatrix) **

  * //This is the constructor with all the parameters needed passed in.//
== Remarks ==
  * //N/A//
== Parameters ==
  * //cacheDirectory//
    * Type:String
    * Description:This parameter specifies the cache directory of the tile cache.

  * //cacheId//
    * Type:String
    * Description:This parameter specifies the cache id of the tile cache.

  * //imageFormat//
    * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]
    * Description:This parameter specifies the image format of the tile cahce.

  * //tileMatrix//
    * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]
    * Description:This parameter specifies the tile matrix of the tile cache.

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} ClearCache(TimeSpan,Double) **

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //tileExpiration//
    * Type:TimeSpan
    * Description:N/A

  * //maxSizeInMegabytes//
    * Type:Double
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //row//
    * Type:Int64
    * Description:N/A

  * //column//
    * Type:Int64
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Collection<String>
  * Description:N/A

== Parameters ==
  * //tileBoundingBox//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
  * Description:N/A

== Parameters ==
  * //tileBoundingBox//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
  * Description:N/A

== Parameters ==
  * //row//
    * Type:Int64
    * Description:N/A

  * //column//
    * Type:Int64
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Collection<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]>
  * Description:N/A

== Parameters ==
  * //worldExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHigherScaleTile(RectangleShape,Double) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
  * Description:N/A

== Parameters ==
  * //tileBoundingBox//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

  * //tileScale//
    * Type:Double
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //tile//
    * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} SaveTiles(GeoImage,RectangleShape) **

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //bitmap//
    * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
    * Description:N/A

  * //bitmapExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //worldExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //tile//
    * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

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

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

  * //N/A//
== Remarks ==
  * //N/A//

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

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

  * //N/A//
== Remarks ==
  * //N/A//

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

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

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

  * //N/A//
== Remarks ==
  * //N/A//

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

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

  * //N/A//
== Remarks ==
  * //N/A//

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

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

  * //This method returns the BitmapTile corresponding to passed in row and column.//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
  * Description:Returns the BitmapTile corresponding to the passed in row and column.

== Parameters ==
  * //row//
    * Type:Int64
    * Description:The target row for the tile to fetch.

  * //column//
    * Type:Int64
    * Description:The target column for the tile to fetch.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} SaveTileCore(Tile) **

  * //This method will save the target tile passed in, you could override this API to create your own logic.//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //tile//
    * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
    * Description:The target tile to be saved.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DeleteTileCore(Tile) **

  * //This method will delete the target tile passed in.//
== Remarks ==
  * //This method will not take effect when the ReadOnly is set to true.//

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

== Parameters ==
  * //tile//
    * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
    * Description:The target tile to be deleted.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} CheckExpiration(String) **

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //tileImageFileName//
    * Type:String
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} GetBinariesFromBitmap(GeoImage) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Byte[]
  * Description:N/A

== Parameters ==
  * //bitmap//
    * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
    * Description:N/A

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

  * //This method will clear all the tiles in the tileCache.//
== Remarks ==
  * //This method will not take effect when the ReadOnly is set to true.//

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

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} GetHigherScaleTileCore(RectangleShape,Double) **

  * //This method overrides the logic in its base class BitmapTileCache. This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut.//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
  * Description:Returns the higher scale(higher zoomLevel) bitmap tile.

== Parameters ==
  * //tileBoundingBox//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:The parameter specifies the current tile bounding box.

  * //tileScale//
    * Type:Double
    * Description:This parameter specifies the current tile scale.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MergeBitmaps(IEnumerable<BitmapTile>,Double) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]
  * Description:N/A

== Parameters ==
  * //tilesToMerge//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]]>
    * Description:N/A

  * //scale//
    * Type:Double
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs) **

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]]
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //N/A//

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

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

  * //N/A//
== Remarks ==
  * //N/A//

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

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

  * //N/A//
== Remarks ==
  * //N/A//

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

== Parameters ==
  * //format//
    * Type:[[ThinkGeo.MapSuite.Portable.GeoImageFormat|GeoImageFormat]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} GetTemporaryFolder() **

  * //N/A//
== Remarks ==
  * //N/A//

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

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

  * //Gets or sets the cache direcory.//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} ExpirationTime **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:TimeSpan

** {{wiki:PublicProperty.gif|}} TileMatrix **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]

** {{wiki:PublicProperty.gif|}} TileAccessMode **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]]

** {{wiki:PublicProperty.gif|}} NoDataTileImage **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]

** {{wiki:PublicProperty.gif|}} LoadingTileImage **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]

** {{wiki:PublicProperty.gif|}} ImageFormat **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]

** {{wiki:PublicProperty.gif|}} JpegQuality **

  * //N/A//
== Remarks ==
  * //N/A//
== Return Value ==
  * Type:Int16

** {{wiki:PublicProperty.gif|}} CacheId **

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

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} CapabilityInMegaBytes **

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

==== Public Events ====
** {{wiki:PublicEvent.gif|}} GottenCacheImage **
  * //N/A//
== Remarks ==
  * //N/A//

Event Arguments:[[ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs|GottenCacheImageBitmapTileCacheEventArgs]]

** {{wiki:PublicEvent.gif|}} GettingCacheImage **
  * //N/A//
== Remarks ==
  * //N/A//

Event Arguments:[[ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs|GettingCacheImageBitmapTileCacheEventArgs]]