Click or drag to resize

DocumentUltimateWebConfiguration Properties

The DocumentUltimateWebConfiguration type exposes the following members.

Properties
  NameDescription
Public propertyCacheAutoTrimInterval
Gets or sets a value that specifies the interval to run automatic cache trimming (clean up). Cached items older than CacheMaxAge will be removed when the cache is trimmed. If the value is 0 or negative, the auto trim is disabled. The default value is 20 minutes. In string representation, value in format "d" is considered days (e.g. "30" is 30 days) and value in format "hh:mm" is considered hours and minutes (e.g. "1:30" is 1 hour and 30 minutes). Note that "24:00" would mean 24 days as hour range is 0 to 23 and minute range is 0 to 59. See Parse(String) documentation for details on possible string representations.
Public propertyCacheEncryptionEnabled
Gets a value that specifies whether encryption of documents should be enabled. The default is true. Document viewer downloads a special document format (XPZ) on the client-side but for additional security (DRM), the document is also encypted by default.
Public propertyCacheKeepVariations
Gets or sets a value that specifies whether to keep variations of document conversion results. The default is false. For instance when you change watermark options, both Pdf and Xpz outputs are regenerated. By default the Pdf and Xpz outputs are replaced in cache when watermarks are changed. If you set this property to true, the Pdf and Xpz outputs will not be replaced but all variations will be kept in cache instead. This can be useful especially when you want different outputs for different users. So this way, for instance you can have different watermarked variations for each different user.
Public propertyCode exampleCacheLocation
Gets or sets the location to store cached documents. The default value is "~/App_Data/DocumentCache". The location can be a plain physical/virtual path string or a Location instance for one of the supported file systems like Amazon S3 and Azure Blob.
Public propertyCacheMaxAge
Gets or sets a value that specifies the maximum amount of time to consider a cached item fresh and keep it stored in the cache. Cached items older than this age will be removed when the cache trimming (clean up) runs (when auto trim is run or when Trim method is manually called). The default value is 90 days. In string representation, value in format "d" is considered days (e.g. "30" is 30 days) and value in format "hh:mm" is considered hours and minutes (e.g. "1:30" is 1 hour and 30 minutes). Note that "24:00" would mean 24 days as hour range is 0 to 23 and minute range is 0 to 59. See Parse(String) documentation for details on possible string representations.
Public propertyCacheWaitTimeout
Gets or sets a value that specifies the maximum amount of time to wait for a cached item to be available (wait for a file lock from other threads or processes to become available, i.e. wait for an ongoing caching of the same file to complete) before giving up on the cache request. The default value is 5 minutes. In string representation, value in format "d" is considered days (e.g. "30" is 30 days) and value in format "hh:mm" is considered hours and minutes (e.g. "1:30" is 1 hour and 30 minutes). Note that "24:00" would mean 24 days as hour range is 0 to 23 and minute range is 0 to 59. See Parse(String) documentation for details on possible string representations.
Public propertyStatic memberCurrent
Gets current global configuration instance.
Public propertyDocumentViewerHandlerPath
Gets or sets a value that specifies the path for the document viewer handler. The default value is "documentviewer.ashx". Normally you would not need to change the default value.
Top
See Also