====== ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache ======

{{section>upgrade_map_suite_to_10.0}}

This class is a concrete class that inherits from FileBitmapTileCache. In this class, the tiles will be marked as obsolete when you call the ClearCache method and will be deleted in a background thread.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.Core.TileCache
      *ThinkGeo.MapSuite.Core.BitmapTileCache
        *ThinkGeo.MapSuite.Core.FileBitmapTileCache
          ***ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} SessionFileBitmapTileCache() **

  * //This is the default constructor.//
== Remarks ==
  * //If you use this constructor, you must set the properties manually.//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} SessionFileBitmapTileCache(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 directory of the tile cache.

<div newline></div>
** {{wiki:PublicMethod.gif|}} SessionFileBitmapTileCache(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 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|}} SessionFileBitmapTileCache(String,String,TileImageFormat,TileMatrix) **

  * //This is the constructor with all the parameters needed passed in.//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#SessionFileBitmapTileCache.28String.2C_String.2C_TileImageFormat.2C_TileMatrix.29//
== Parameters ==
  * //cacheDirectory//
    * Type:String
    * Description:This parameter specifies the directory of the tile cache.

  * //cacheId//
    * Type:String
    * Description:This parameter specifies the cache IF 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) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here://

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

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here://

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

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here://

== 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|}} GetTileImageFileNames(RectangleShape) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetTileImageFileNames.28RectangleShape.29//

== 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|}} GetTileImageFileName(Int64,Int64) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetTileImageFileName.28Int64.2C_Int64.29//

== 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|}} GetTile(RectangleShape) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetTile.28RectangleShape.29//

== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetTile.28Int64.2C_Int64.29//

== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetTiles.28RectangleShape.29//

== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetHigherScaleTile.28RectangleShape.2C_Double.29//

== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#SaveTile.28Tile.29//

== 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(Bitmap,RectangleShape,Boolean) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here://

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

== Parameters ==
  * //bitmap//
    * Type:Bitmap
    * Description:N/A

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

  * //saveContainedCellsOnly//
    * Type:Boolean
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#SaveTiles.28Bitmap.2C_RectangleShape.29//

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

== Parameters ==
  * //bitmap//
    * Type:Bitmap
    * Description:N/A

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#DeleteTiles.28RectangleShape.29//

== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#DeleteTile.28Tile.29//

== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#ClearCache.28.29//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#ToString.28.29//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#Equals.28Object.29//

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

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetHashCode.28.29//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetType.28.29//

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

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

  * //This method will create a new cacheId for the SessionFileBitmapTileCache and mark the original one as obsolete. The original will then be deleted in a background thread.//
== Remarks ==
  * //This method will not take effect when ReadOnly is set to true.//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetTileCore.28Int64.2C_Int64.29//

== 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:ProtectedMethod.gif|}} SaveTileCore(Tile) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#SaveTileCore.28Tile.29//

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

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#DeleteTileCore.28Tile.29//

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

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

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 8xU=(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|}} 9BU=(Bitmap) **

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

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

== Parameters ==
  * //bitmap//
    * Type:Bitmap
    * Description:N/A

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#GetHigherScaleTileCore.28RectangleShape.2C_Double.29//

== 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:ProtectedMethod.gif|}} MergeBitmaps(IEnumerable<BitmapTile>,Double) **

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here://

== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#OnGottenCacheImage.28GottenCacheImageBitmapTileCacheEventArgs.29//

== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#OnGettingCacheImage.28GettingCacheImageBitmapTileCacheEventArgs.29//

== 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 ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#Finalize.28.29//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#MemberwiseClone.28.29//

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

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#CacheDirectory//
== Return Value ==
  * Type:String

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#ExpirationTime//
== Return Value ==
  * Type:TimeSpan

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#SessionFileBitmapTileCache.28String.2C_String.2C_TileImageFormat.2C_TileMatrix.29//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#TileAccessMode//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]]

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#NoDataTileImage//
== Return Value ==
  * Type:Bitmap

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#LoadingTileImage//
== Return Value ==
  * Type:Bitmap

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#SessionFileBitmapTileCache.28String.2C_String.2C_TileImageFormat.2C_TileMatrix.29//
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#JpegQuality//
== Return Value ==
  * Type:Int16

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

  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#CacheId//
== Return Value ==
  * Type:String

==== Protected Properties ====
==== Public Events ====
** {{wiki:PublicEvent.gif|}} GottenCacheImage **
  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#OnGottenCacheImage.28GottenCacheImageBitmapTileCacheEventArgs.29//

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

** {{wiki:PublicEvent.gif|}} GettingCacheImage **
  * //N/A//
== Remarks ==
  * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.SessionFileBitmapTileCache#OnGettingCacheImage.28GettingCacheImageBitmapTileCacheEventArgs.29//

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