GetBizFormFileHandlerBase Class

Base handler class for serving biz form files.

Inheritance Hierarchy

System.Object
  CMS.Routing.Web.AdvancedGetFileHandler
    CMS.OnlineForms.Internal.GetBizFormFileHandlerBase

Namespace: CMS.OnlineForms.Internal
Assembly: CMS.OnlineForms (in CMS.OnlineForms.dll) Version: 12.0.0

Syntax

public abstract class GetBizFormFileHandlerBase : AdvancedGetFileHandler

The GetBizFormFileHandlerBase type exposes the following members.

Constructors

	Name	Description
Protected method	GetBizFormFileHandlerBase

Fields

	Name	Description
Protected field	deviceResizeIsUsed	Indicates if max resize for mobile device is used. (Inherited from AdvancedGetFileHandler.)
Protected field	mAllowCache	If true, the caching is allowed. (Inherited from AdvancedGetFileHandler.)
Protected field	mCacheMinutes	Cache minutes (Inherited from AdvancedGetFileHandler.)
Protected field	mClientCacheMinutes	Client cache minutes (Inherited from AdvancedGetFileHandler.)
Protected field	mCompleted	Indicates whether request is completed (Inherited from AdvancedGetFileHandler.)
Protected field	mHeight	Height (Inherited from AdvancedGetFileHandler.)
Protected field	mMaxSideSize	Max. side size (Inherited from AdvancedGetFileHandler.)
Protected field	mResizeToDevice	Indicates whether resizing should be used for device (Inherited from AdvancedGetFileHandler.)
Protected field	mRevalidateClientCache	Indicates whether client cache should be revalidated (Inherited from AdvancedGetFileHandler.)
Protected field	mWidth	Width (Inherited from AdvancedGetFileHandler.)
Protected field	useCacheItemName	Cache item name for the request. (Inherited from AdvancedGetFileHandler.)

Properties

	Name	Description
Protected property	AcceptRange	Indicates if resumable downloads should be supported for current file. (Inherited from AdvancedGetFileHandler.)
Public property	AllowCache	Indicates whether caching is allowed. Returns false. (Overrides AdvancedGetFileHandler.AllowCache.)
Public property	AllowClientCache	Returns true if client cache is allowed for the current request. (Inherited from AdvancedGetFileHandler.)
Public property	CacheMinutes	Cache minutes. (Inherited from AdvancedGetFileHandler.)
Public property	ClientCacheMinutes	Cache minutes. (Inherited from AdvancedGetFileHandler.)
Protected property	Context	Returns the current context (Inherited from AdvancedGetFileHandler.)
Public property	CurrentSite	Current site. (Inherited from AdvancedGetFileHandler.)
Public property	CurrentSiteName	Current site name. (Inherited from AdvancedGetFileHandler.)
Public property	ETag	HTTP header entity tag. (Inherited from AdvancedGetFileHandler.)
Public property	Height	Image height. (Inherited from AdvancedGetFileHandler.)
Protected property	IsLiveSite	Indicates if live site mode. (Inherited from AdvancedGetFileHandler.)
Public property	IsMultipart	Indicates whether it is multipart range request. (Inherited from AdvancedGetFileHandler.)
Public property	IsRangeRequest	Indicates whether it is range request. (Inherited from AdvancedGetFileHandler.)
Public property	IsReusable	Indicates if handler is reusable. (Inherited from AdvancedGetFileHandler.)
Public property	LogCommunicationExceptions	Whether to log exception caused by communication problems (e.g. when remote host closes the connection). Log exceptions has to be set to TRUE. (Inherited from AdvancedGetFileHandler.)
Public property	LogExceptions	Logs the exceptions caused by the process. (Inherited from AdvancedGetFileHandler.)
Public property	MaxSideSize	Image maximum side size. (Inherited from AdvancedGetFileHandler.)
Public property	OutputDataCacheItemName	Cache item name for the file output data. (Inherited from AdvancedGetFileHandler.)
Public property	ResizeToDevice	Indicates if max side size parameter should be changes to device profile dimensions. (Inherited from AdvancedGetFileHandler.)
Public property	Response	Returns the current response (Inherited from AdvancedGetFileHandler.)
Public property	RevalidateClientCache	Cache minutes. (Inherited from AdvancedGetFileHandler.)
Protected property	Sender	Gets or sets sender object that is used for writing data to the response. (Inherited from AdvancedGetFileHandler.)
Public property	Watermark	If set, watermark image is applied to the image. Name of the watermark image from ~/App_Themes/{theme}/Images/Watermarks (Inherited from AdvancedGetFileHandler.)
Public property	WatermarkPosition	Watermark position. (Inherited from AdvancedGetFileHandler.)
Public property	Width	Image width. (Inherited from AdvancedGetFileHandler.)

Methods

	Name	Description
Protected method	CompleteRequest	Completes the request. (Inherited from AdvancedGetFileHandler.)
Protected method	ETagsMatch	Responds with 304 Not Modified if ETags match and object has current timestamp. (Inherited from AdvancedGetFileHandler.)
Protected method	GetBaseCacheKey	Returns the base cache key (created with all parameters considered to be valid for proper caching). (Inherited from AdvancedGetFileHandler.)
Protected method	GetCacheDependency	Creates the cache dependency from the given keys. (Inherited from AdvancedGetFileHandler.)
Protected method	GetCachedOutputData	Gets the cached data for the current request. (Inherited from AdvancedGetFileHandler.)
Protected method	GetRange	Parses the range header from the request. (Inherited from AdvancedGetFileHandler.)
Protected method	HandleDeviceDimension	Handles max side size according to device profile dimensions. (Inherited from AdvancedGetFileHandler.)
Protected method	HandleDeviceResize	Changes MaxSideSize to device dimensions if device resizing is enabled. (Inherited from AdvancedGetFileHandler.)
Protected method	IsExtensionExcludedFromRanges	Indicates if file with given extension is excluded from resumable downloads. (Inherited from AdvancedGetFileHandler.)
Protected method	LoadSiteName	Loads the site name from the query string. (Inherited from AdvancedGetFileHandler.)
Public method	ProcessRequest	Processes the handler request (Inherited from AdvancedGetFileHandler.)
Protected method	ProcessRequestBase	Processes biz form file request.
Protected method	ProcessRequestInternal	Processes the handler request (Inherited from AdvancedGetFileHandler.)
Protected method	RespondNotModified	Responds with the not modified code. (Inherited from AdvancedGetFileHandler.)
Protected method	SaveOutputDataToCache	Saves the data for current request to cache. (Inherited from AdvancedGetFileHandler.)
Protected method	SetCacheability	Sets the cache-ability with dependence on connection type IE browser doesn't support No-Cache if current connection is secured (Inherited from AdvancedGetFileHandler.)
Protected method	SetDisposition	Sets response header according to file type. (Inherited from AdvancedGetFileHandler.)
Protected method	SetResponseContentType	Sets content type of the response based on file MIME type (Inherited from AdvancedGetFileHandler.)
Protected method	SetRevalidation	Sets the revalidation of the client caches. (Inherited from AdvancedGetFileHandler.)
Protected method	SetTimeStamps	Sets the last modified and expires header to the response (Inherited from AdvancedGetFileHandler.)
Protected method	WriteBytes	Streams the byte array to the response. (Inherited from AdvancedGetFileHandler.)
Protected method	WriteFile	Streams the data file to the response. (Inherited from AdvancedGetFileHandler.)

Remarks

This API supports the framework infrastructure and is not intended to be used directly from your code.