FileImageDataProvider Attributes

The following attributes may be set within the web.config to specify your built-in FileImageDataProvider:

name - (Required) Specifies the name of the image data provider.

When using the build-in provider, the name must be specified as "FileImageDataProvider". If you use the built in provider, and do not provide this name in the name attribute value, your images will not display. The name coincides with the name of the class. When you write your own custom data providers, this name can be any string that you give in your code. Refer to the Radiology Office sample for an example of a custom image data provider.

type - (Required) Specifies the provider class and the assembly in which it resides. (For the built-in provider, the assembly is ImageGear21.Web.Services).

If your provider is a class in your application, then the assembly name is not required.

storageRootPath - (Required) Specifies the root folder path where the image files are stored. This can be changed to suit your image storage system. The '~' character specifies that it is relative to the web application path.

Absolute and UNC Paths are also accepted. Make sure that when you deploy your web site that the IIS user (usually Network service user) has access to this folder. Without the necessary folder read/write access permissions to the IIS user, the images won't display.

maxImageSizeToCache - Allows you to put an upper limit on the size of the image that can be cached. When deciding on the value, bear in mind the amount of memory your system has. A larger value on infrequently used images will unnecessarily use up the memory for cache. This value is in kilobytes. The default value is 512K.
cachingTimeLimit - Represents the amount of time in minutes that the image is to remain in the cache. Upon remaining in the cache for the amount of time specified, the system flushes the cache of the stored image. The default value is five minutes (cachingTimeLimit==5).
cachingEnable - (Required) Indicates whether caching is enabled. This attribute has a boolean value ("true" or "false").
- A value of "false" will disable all caching. (Default value)
- A value of "true" will enable caching.
  
  The annotations data is never cached.