Click or drag to resize
AbstractGetSharePointFileHandler Class
Abstract SharePoint handler that serves SharePoint files.
Inheritance Hierarchy
SystemObject
  CMS.Routing.WebGetFileHandler
    CMS.SharePointAbstractGetSharePointFileHandler

Namespace: CMS.SharePoint
Assembly: CMS.SharePoint (in CMS.SharePoint.dll) Version: 12.0.0
Syntax
C#
public abstract class AbstractGetSharePointFileHandler : GetFileHandler

The AbstractGetSharePointFileHandler type exposes the following members.

Constructors
  NameDescription
Protected methodAbstractGetSharePointFileHandler
Top
Fields
  NameDescription
Protected fieldStatic memberCACHE_SIZE_PARAMETER
Name of the query parameter for cahe size limit setting.
Protected fieldStatic memberCACHE_TIME_PARAMETER
Name of the query parameter for cahe minutes setting.
Protected fieldStatic memberIMAGE_HEIGHT_PARAMETER
Name of the query parameter for image height setting.
Protected fieldStatic memberIMAGE_MAXSIDESIZE_PARAMETER
Name of the query parameter for image max side size setting.
Protected fieldStatic memberIMAGE_WIDTH_PARAMETER
Name of the query parameter for image width setting.
Top
Properties
  NameDescription
Protected propertyAllowCache
Returns true if the process allows cache.
Protected propertyAllowClientCache
Returns true if client cache is allowed for the current request.
(Inherited from GetFileHandler.)
Protected propertyCacheFileSizeLimit
Maximum size of the file that will be cached (bytes).
Protected propertyCacheItemName
Gets the cahe item name for currently requested file that will be used when composing the cahe key.
Protected propertyCacheMinutes
Number of minutes the file will be cached. Zero means the file won't be cahed.
Protected propertyClientCacheMinutes
Client cache minutes.
(Inherited from GetFileHandler.)
Protected propertyContext
Current HTTP context.
(Inherited from GetFileHandler.)
Protected propertyForceDownload
Indicates whether file forced to be saved on client
Protected propertyHeight
Image height.
Protected propertyIsLiveSite
Indicates if live site mode.
(Inherited from GetFileHandler.)
Public propertyIsReusable
Indicates if handler is reusable.
(Inherited from GetFileHandler.)
Protected propertyMaxSideSize
Image maximum side size.
Protected propertyResponse
Current HTTP response.
(Inherited from GetFileHandler.)
Protected propertyRevalidateClientCache
Indicates if client cache should be revalidated.
(Inherited from GetFileHandler.)
Protected propertySender
Instance of the sender object that is used for writing data to the response.
(Inherited from GetFileHandler.)
Protected propertyWidth
Image width.
Top
Methods
  NameDescription
Protected methodCompleteRequest
Completes the request.
(Inherited from GetFileHandler.)
Protected methodFileNotFound
Responds HTTP code 404 Not Found.
(Inherited from GetFileHandler.)
Protected methodGetSharePointFile
Gets the requested SharePoint file.
Protected methodHandleClientCache
Sets client cache headers. Responds HTTP code 304 Not Modified and returns true when requested file is in client's cache.
(Inherited from GetFileHandler.)
Protected methodLoadFile
Loads requested SharePoint file. Image is resized when needed.
Protected methodLoadFile(CacheSettings)
Loads requested SharePoint file. Loaded file will be cached if it satisfies the cache conditions.
Public methodProcessRequest
Process the request.
(Inherited from GetFileHandler.)
Protected methodProcessRequestInternal
Process get SharePoint file request.
(Overrides GetFileHandlerProcessRequestInternal(HttpContext).)
Protected methodRespondNotModified
Responds HTTP code 304 Not Modified.
(Inherited from GetFileHandler.)
Protected methodSendFile
Sends the given file within response.
Protected methodSetResponseHeaders
Sets response headers.
(Inherited from GetFileHandler.)
Protected methodValidateRequest
Validates the request. Returns true on success.
Protected methodWriteBytes
Streams the byte array to the response.
(Inherited from GetFileHandler.)
Top
See Also