AbstractGetSharePointFileHandler Class

Abstract SharePoint handler that serves SharePoint files.

Inheritance Hierarchy

System.Object
  CMS.UIControls.GetFileHandler
    CMS.SharePoint.AbstractGetSharePointFileHandler
      CMS.SharePoint.GetLocalSharePointFileHandler
      CMS.SharePoint.GetSharePointFileHandler

Namespace: CMS.SharePoint
Assembly: CMS.SharePoint (in CMS.SharePoint.dll) Version: 8.2.23

Syntax

public abstract class AbstractGetSharePointFileHandler : GetFileHandler

The AbstractGetSharePointFileHandler type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractGetSharePointFileHandler

Methods

	Name	Description
Protected method	CompleteRequest	Completes the request. (Inherited from GetFileHandler.)
Protected method	FileNotFound	Responds HTTP code 404 Not Found. (Inherited from GetFileHandler.)
Protected method	GetSharePointFile	Gets the requested SharePoint file.
Protected method	HandleClientCache	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 method	LoadFile()	Loads requested SharePoint file. Image is resized when needed.
Protected method	LoadFile(CacheSettings)	Loads requested SharePoint file. Loaded file will be cached if it satisfies the cache conditions.
Public method	ProcessRequest	Process the request. (Inherited from GetFileHandler.)
Protected method	ProcessRequestInternal	Process get SharePoint file request. (Overrides GetFileHandler.ProcessRequestInternal(HttpContext).)
Protected method	RespondNotModified	Responds HTTP code 304 Not Modified. (Inherited from GetFileHandler.)
Protected method	SendFile	Sends the given file within response.
Protected method	SetResponseHeaders	Sets response headers. (Inherited from GetFileHandler.)
Protected method	ValidateRequest	Validates the request. Returns true on success.
Protected method	WriteBytes	Streams the byte array to the response. (Inherited from GetFileHandler.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field Static member	CACHE_SIZE_PARAMETER	Name of the query parameter for cahe size limit setting.
Protected field Static member	CACHE_TIME_PARAMETER	Name of the query parameter for cahe minutes setting.
Protected field Static member	IMAGE_HEIGHT_PARAMETER	Name of the query parameter for image height setting.
Protected field Static member	IMAGE_MAXSIDESIZE_PARAMETER	Name of the query parameter for image max side size setting.
Protected field Static member	IMAGE_WIDTH_PARAMETER	Name of the query parameter for image width setting.
Protected field	mSender	Instance of the sender object that is used for writing data to the response. (Inherited from GetFileHandler.)

Properties

	Name	Description
Protected property	AllowCache	Returns true if the process allows cache.
Protected property	AllowClientCache	Returns true if client cache is allowed for the current request. (Inherited from GetFileHandler.)
Protected property	CacheFileSizeLimit	Maximum size of the file that will be cached (bytes).
Protected property	CacheItemName	Gets the cahe item name for currently requested file that will be used when composing the cahe key.
Protected property	CacheMinutes	Number of minutes the file will be cached. Zero means the file won't be cahed.
Protected property	ClientCacheMinutes	Client cache minutes. (Inherited from GetFileHandler.)
Protected property	Context	Current HTTP context. (Inherited from GetFileHandler.)
Protected property	ForceDownload	Indicates whether file forced to be saved on client
Protected property	Height	Image height.
Protected property	IsLiveSite	Indicates if live site mode. (Inherited from GetFileHandler.)
Public property	IsReusable	Indicates if handler is reusable. (Inherited from GetFileHandler.)
Protected property	MaxSideSize	Image maximum side size.
Protected property	Response	Current HTTP response. (Inherited from GetFileHandler.)
Protected property	RevalidateClientCache	Indicates if client cahce should be revalidated. (Inherited from GetFileHandler.)
Protected property	Width	Image width.