Back to all docs
API Reference / Telerik.Windows.Controls.Map / FileCacheBase
New to Telerik UI for WPF? Start a free 30-day trial

FileCacheBase

Class

The base file cache class.

Definition

Namespace:Telerik.Windows.Controls.Map

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:
C#
public abstract class FileCacheBase : MemoryCache, ICacheStorage

Inheritance: objectMemoryCacheFileCacheBase

Derived Classes: FileSystemCacheIsolatedStorageCache

Implements: ICacheStorage

Inherited Members MemoryCache.MemoryMaxSizePropertyMemoryCache.GetTile(string)MemoryCache.GetCacheRecord(string)MemoryCache.AddToCacheRecords(MemoryCache.CacheRecord)MemoryCache.MemoryMaxSize

Constructors

FileCacheBase()

Initializes a new instance of the FileCacheBase class.

C#
protected FileCacheBase()

Fields

CachePathProperty

DependencyProperty

Identifies the CachePath dependency property.

C#
public static readonly DependencyProperty CachePathProperty

MaxExpirationTimeProperty

DependencyProperty

Identifies the MaxExpiresTime dependency property.

C#
public static readonly DependencyProperty MaxExpirationTimeProperty

MaxSizeProperty

DependencyProperty

Identifies the MaxSize dependency property.

C#
public static readonly DependencyProperty MaxSizeProperty

MinExpirationTimeProperty

DependencyProperty

Identifies the MinExpiresTime dependency property.

C#
public static readonly DependencyProperty MinExpirationTimeProperty

Properties

CachePath

Gets or sets the path to files for a storage. This is a dependency property.

C#
public string CachePath { get; set; }

MaxExpirationTime

Gets or sets the maximal expiration timespan for a file in cache. This is a dependency property.

C#
public TimeSpan MaxExpirationTime { get; set; }

MaxSize

Gets or sets the maximal cache size for a storage. Zero value specifies unlimited cache. This is a dependency property.

C#
public long MaxSize { get; set; }

MinExpirationTime

Gets or sets the minimal expiration timespan for a file in cache. This is a dependency property.

C#
public TimeSpan MinExpirationTime { get; set; }

Methods

CreateCacheStream(string)

Creates cache stream.

C#
protected abstract Stream CreateCacheStream(string fileName)
Parameters:fileNamestring

File name.

Returns:

Stream

Stream to saving into cache.

Dispose()

Dispose all resources are used by the FileCacheBase.

C#
public void Dispose()

GetFiles(string, string)

Obtains files.

C#
protected abstract string[] GetFiles(string cachePath, string fileMask)
Parameters:cachePathstring

Cache path.

fileMaskstring

File mask.

Returns:

string[]

Array of file names.

GetFullFilePath(string)

Returns full file path.

C#
protected string GetFullFilePath(string fileName)
Parameters:fileNamestring

File name.

Returns:

string

Full file path.

Load(string)

Loads the file from the storage.

C#
public override Stream Load(string fileName)
Parameters:fileNamestring

File name.

Returns:

Stream

Stream if the file exists and does not expired or null.

Overrides: MemoryCache.Load(string)

LoadAsync(string, Action<byte[]>)

Loaded file from a cache to event arguments.

C#
public override void LoadAsync(string fileName, Action<byte[]> callback)
Parameters:fileNamestring

File name.

callbackAction<byte[]>

Callback which should be called to return tile if it is available or null.

Overrides: MemoryCache.LoadAsync(string, Action<byte[]>)

LoadFileMetadata(string)

Loads file metadata.

C#
protected abstract MemoryCache.ICacheRecordMetadata LoadFileMetadata(string fileName)
Parameters:fileNamestring

File name.

Returns:

MemoryCache.ICacheRecordMetadata

ICacheRecordMetadata implementation instance.

OnCachePathChanged(string, string)

Calls when the cache path is changed.

C#
protected virtual void OnCachePathChanged(string oldValue, string newValue)
Parameters:oldValuestring

Old path.

newValuestring

New path.

OnMaxSizeChanged()

Sets thread safety max size value.

C#
protected virtual void OnMaxSizeChanged()

OpenCacheStream(string)

Gets cache stream.

C#
protected abstract Stream OpenCacheStream(string fileName)
Parameters:fileNamestring

File name.

Returns:

Stream

Stream to loading from cache.

RemoveFile(string)

Removes file from cache storage.

C#
protected abstract void RemoveFile(string fileName)
Parameters:fileNamestring

File name.

Save(string, DateTime, byte[])

Saves the file to the storage.

C#
public override void Save(string fileName, DateTime expirationDate, byte[] tile)
Parameters:fileNamestring

File name.

expirationDateDateTime

Expiration date.

tilebyte[]

Byte array which is saved to the file.

Overrides: MemoryCache.Save(string, DateTime, byte[])

SaveFileMetadata(ICacheRecordMetadata)

Saves file metadata.

C#
protected abstract void SaveFileMetadata(MemoryCache.ICacheRecordMetadata cacheRecord)
Parameters:cacheRecordMemoryCache.ICacheRecordMetadata

Cache record metadata.

In this article
DefinitionConstructorsFileCacheBase()FieldsCachePathPropertyMaxExpirationTimePropertyMaxSizePropertyMinExpirationTimePropertyPropertiesCachePathMaxExpirationTimeMaxSizeMinExpirationTimeMethodsCreateCacheStream(string)Dispose()GetFiles(string, string)GetFullFilePath(string)Load(string)LoadAsync(string, Action<byte[]>)LoadFileMetadata(string)OnCachePathChanged(string, string)OnMaxSizeChanged()OpenCacheStream(string)RemoveFile(string)Save(string, DateTime, byte[])SaveFileMetadata(ICacheRecordMetadata)
Not finding the help you need?
Contact Support