Click or drag to resize
AdvancedGetFileHandler Class
Base page for GetFile pages.
Inheritance Hierarchy

Namespace: CMS.Routing.Web
Assembly: CMS.Routing.Web (in CMS.Routing.Web.dll) Version: 10.0.0
Syntax
C#
public abstract class AdvancedGetFileHandler : IHttpHandler, 
	IReadOnlySessionState, IRequiresSessionState

The AdvancedGetFileHandler type exposes the following members.

Constructors
  NameDescription
Protected methodAdvancedGetFileHandler
Top
Fields
  NameDescription
Protected fielddeviceResizeIsUsed
Indicates if max resize for mobile device is used.
Protected fieldmAllowCache
If true, the caching is allowed.
Protected fieldmCacheMinutes
Cache minutes
Protected fieldmClientCacheMinutes
Client cache minutes
Protected fieldmCompleted
Indicates whether request is completed
Protected fieldmHeight
Height
Protected fieldmMaxSideSize
Max. side size
Protected fieldmResizeToDevice
Indicates whether resizing should be used for device
Protected fieldmRevalidateClientCache
Indicates whether client cache should be revalidated
Protected fieldmWidth
Width
Protected fielduseCacheItemName
Cache item name for the request.
Top
Properties
  NameDescription
Protected propertyAcceptRange
Indicates if resumable downloads should be supported for current file.
Protected propertyStatic memberAcceptRanges
Indicates whether range requests are enabled (ex. for resumable downloads). If false, the HTTP Handler ignores the Range HTTP Header and returns the entire contents.
Public propertyAllowCache
Returns true if the process allows cache.
Public propertyAllowClientCache
Returns true if client cache is allowed for the current request.
Public propertyAreRangesValid
Indicates whether ranges are valid. TRUE: ranges are valid or request is not range request FALSE: all other cases
Public propertyCacheItemName
Cache item name for current request.
Public propertyCacheMinutes
Cache minutes.
Public propertyClientCacheMinutes
Cache minutes.
Protected propertyContext
Returns the current context
Public propertyCurrentSite
Current site.
Public propertyCurrentSiteName
Current site name.
Public propertyCurrentUser
Current User.
Public propertyDataLength
Size of data.
Public propertyETag
HTTP header entity tag.
Protected propertyStatic memberExcludedResumableExtensions
List of file extensions for which the resumable downloads are disabled.
Protected propertyStatic memberGetFileEndRequest
When true, the request is completed, when false, the Request.End is called.
Public propertyHeight
Image height.
Protected propertyIsLiveSite
Indicates if live site mode.
Public propertyIsMultipart
Indicates whether it is multipart range request.
Public propertyIsRangeRequest
Indicates whether it is range request.
Public propertyIsReusable
Indicates if handler is reusable.
Public propertyLogCommunicationExceptions
Whether to log exception caused by communication problems (e.g. when remote host closes the connection). Log exceptions has to be set to TRUE.
Public propertyLogExceptions
Logs the exceptions caused by the process.
Public propertyMaxSideSize
Image maximum side size.
Public propertyOutputDataCacheItemName
Cache item name for the file output data.
Protected propertyStatic memberRangeRegExp
The range from HTTP header regular expression.
Public propertyRanges
2D Array in format {{START_RANGE,END_RANGE},{START_RANGE, END_RANGE}}.
Public propertyResizeToDevice
Indicates if max side size parameter should be changes to device profile dimensions.
Public propertyResponse
Returns the current response
Public propertyRevalidateClientCache
Cache minutes.
Protected propertySender
Gets or sets sender object that is used for writing data to the response.
Public propertyWatermark
If set, watermark image is applied to the image. Name of the watermark image from ~/App_Themes/{theme}/Images/Watermarks
Public propertyWatermarkPosition
Watermark position.
Public propertyWidth
Image width.
Top
Methods
  NameDescription
Protected methodCompleteRequest
Completes the request.
Protected methodETagsMatch
Responds with 304 Not Modified if ETags match and object has current timestamp.
Protected methodGetBaseCacheKey
Returns the base cache key (created with all parameters considered to be valid for proper caching).
Protected methodGetCacheDependency
Creates the cache dependency from the given keys.
Protected methodGetCachedOutputData
Gets the cached data for the current request.
Protected methodGetRange
Parses the range header from the request.
Protected methodHandleDeviceDimension
Handles max side size according to device profile dimensions.
Protected methodHandleDeviceResize
Changes MaxSideSize to device dimensions if device resizing is enabled.
Protected methodIsExtensionExcludedFromRanges
Indicates if file with given extension is excluded from resumable downloads.
Protected methodLoadSiteName
Loads the site name from the query string.
Public methodProcessRequest
Processes the handler request
Protected methodProcessRequestInternal
Processes the handler request
Protected methodRespondNotModified
Responds with the not modified code.
Protected methodSaveOutputDataToCache
Saves the data for current request to cache.
Protected methodSetCacheability
Sets the cache-ability with dependence on connection type IE browser doesn't support No-Cache if current connection is secured
Protected methodSetDisposition
Sets response header according to file type.
Protected methodSetResponseContentType
Sets content type of the response based on file MIME type
Protected methodSetRevalidation
Sets the revalidation of the client caches.
Protected methodSetTimeStamps
Sets the last modified and expires header to the response
Protected methodWriteBytes
Streams the byte array to the response.
Protected methodWriteFile
Streams the data file to the response.
Top
See Also