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

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23
Syntax
C#
public abstract class GetFilePage : AbstractCMSPage

The GetFilePage type exposes the following members.

Constructors
  NameDescription
Protected methodGetFilePage
Initializes a new instance of GetFilePage class.
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractCMSPage.)
Public methodAddHeaderActions
Adds the list of header actions to the page header actions.
(Inherited from AbstractCMSPage.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddMessage
Adds text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractCMSPage.)
Protected methodCompleteRequest
Completes the request.
Protected methodDisableDebugging
Disables all debugging for current page
Public methodEnsureFootersControl
Ensures the page footer control.
(Inherited from AbstractCMSPage.)
Public methodEnsureScriptManager
Ensures the script manager on the page.
(Inherited from AbstractCMSPage.)
Protected methodETagsMatch
Responds with 304 Not Modified if ETags match and object has current timestamp.
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractCMSPage.)
Public methodEvalReturnType(String)
Templated Eval, returns the value converted to specific type.
(Inherited from AbstractCMSPage.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractCMSPage.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractCMSPage.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractCMSPage.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractCMSPage.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractCMSPage.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractCMSPage.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractCMSPage.)
Public methodEvalText
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractCMSPage.)
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 methodGetDocumentManagerContainer
Gets control ideal for containing document manager.
(Inherited from AbstractCMSPage.)
Public methodGetImageUrl
Gets UI image URL.
(Inherited from AbstractCMSPage.)
Public methodGetObjectIconUrl Obsolete.
Gets the icon for the given object type.
(Inherited from AbstractCMSPage.)
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 methodCheckRequiredMimeType
Checks if attachment mime type is allowed.
Public methodInitDebug
Initializes the debug controls.
(Inherited from AbstractCMSPage.)
Public methodInitDevTools
Initializes the Dev tools menu
(Inherited from AbstractCMSPage.)
Protected methodIsExtensionExcludedFromRanges
Indicates if file with given extension is excluded from resumable downloads.
Protected methodLoadContextHelp
Loads application description and help topics with respect to current UI context. Does nothing when context help not enabled or not on standard page.
(Inherited from AbstractCMSPage.)
Protected methodLoadSiteName
Loads the site name from the query string.
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractCMSPage.)
Public methodLogAndShowError
Logs the exception and displays a general error message
(Inherited from AbstractCMSPage.)
Protected methodNotFound
File not found action.
Protected methodOnInit
Init event handler.
(Overrides AbstractCMSPageOnInit(EventArgs).)
Protected methodOnLoad
Load event handler.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreInit
PreInit event handler.
(Overrides AbstractCMSPageOnPreInit(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Overrides AbstractCMSPageOnPreRender(EventArgs).)
Protected methodOnPreRenderComplete
Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered.
(Inherited from AbstractCMSPage.)
Protected methodOnUnload
Unload event handler.
(Overrides ControlOnUnload(EventArgs).)
Public methodRegisterBodyModifyingScript
Registers script that modified body element. (For IE7,8 compatibility reasons. See KB927917 for more information.)
(Inherited from AbstractCMSPage.)
Protected methodRegisterContextHelpScript
Registers script which passes application description and help topics to UI. If applicationName is null or empty, no application context is assumed (and applicationDescriptionUrl, applicationHelpTopics is not used).
(Inherited from AbstractCMSPage.)
Protected methodRender
Render event handler.
(Overrides PageRender(HtmlTextWriter).)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractCMSPage.)
Protected methodRespondNotModified
Responds with the not modified code.
Protected methodSaveOutputDataToCache
Saves the data for current request to cache.
Protected methodSetCacheability
Sets the cacheability 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 methodSetFormAction
Sets the form action for current page if was rewritten by URL rewriter
(Inherited from AbstractCMSPage.)
Protected methodSetRevalidation
Sets the revalidation of the client caches.
Protected methodSetTimeStamps
Sets the last modified and expires header to the response
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractCMSPage.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractCMSPage.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractCMSPage.)
Public methodShowMessage
Shows the specified message, optionally with a tooltip text and description.
(Inherited from AbstractCMSPage.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.)
Protected methodStatic memberValidateCulture
Validats the current request culture
Protected methodWriteBytes
Streams the byte array to the response.
Protected methodWriteFile
Streams the data file to the response.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodCallHandled
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodLoadUserControl
Loads the user control based on the given path
(Defined by ControlsExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
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 fieldmContextMenuContainer
Container control for the context menus.
(Inherited from AbstractCMSPage.)
Protected fieldmDocumentBase
Document base.
Protected fieldmDocumentManager
Document manager control.
(Inherited from AbstractCMSPage.)
Protected fieldmFootersContainer
Container control for the page footers.
(Inherited from AbstractCMSPage.)
Protected fieldmHeaderActions
Header actions
(Inherited from AbstractCMSPage.)
Protected fieldmHeight
Height
Protected fieldmLogsContainer
Container control for the log controls.
(Inherited from AbstractCMSPage.)
Protected fieldmManagersContainer
Container control for the page managers.
(Inherited from AbstractCMSPage.)
Protected fieldmMaxByteStream
Max. byte stream
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 fieldmScriptManagerControl
Script manager control.
(Inherited from AbstractCMSPage.)
Protected fieldmViewMode
View mode
Protected fieldmWidth
Width
Protected fieldthrow404WhenNotFound
If true, 404 is thrown when the file is not found.
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 propertyAfterFormPlaceHolder
Gets placeholder located after form element.
(Inherited from AbstractCMSPage.)
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 propertyStatic memberBUFFER_SIZE Obsolete.
Buffer size 64 kB.
Public propertyCacheItemName
Cache item name for current request.
Public propertyCacheMinutes
Cache minutes.
Public propertyClientCacheMinutes
Cache minutes.
Public propertyStatic memberCONNECTION_CHECK Obsolete.
Check connection every X buffering iterations.
Public propertyStatic memberCONNECTION_TIMEOUT Obsolete.
Connection timeout (seconds).
Public propertyContextMenuContainer
Container control for the context menus.
(Inherited from AbstractCMSPage.)
Public propertyCultureCode
Gets culture code of current document initialized from query string.
(Inherited from AbstractCMSPage.)
Public propertyCurrentSite
Current site.
Public propertyCurrentSiteName
Current site name.
Public propertyCurrentUser
Current User.
Public propertyCurrentUseXUACompatible
If true, X-UA-Compatible header will be added to the page.
(Inherited from AbstractCMSPage.)
Public propertyDataLength
Size of data.
Public propertyDocumentBase
Document base.
Public propertyDocumentID
Gets document ID of current document initialized from query string.
(Inherited from AbstractCMSPage.)
Public propertyDocumentManager
Document manager control.
(Inherited from AbstractCMSPage.)
Protected propertyEnableContextHelp
Tells you whether context help script generation into page is enabled.
(Inherited from AbstractCMSPage.)
Protected propertyEnsureDocumentManager
Indicates if document manager should be ensured
(Inherited from AbstractCMSPage.)
Public propertyEnsurePreferredCulture
Indicates if content preferred culture should be ensured.
(Inherited from AbstractCMSPage.)
Public propertyETag
HTTP header entity tag.
Protected propertyStatic memberExcludedResumableExtensions
List of file extensions for which the resumable downloads are disabled.
Public propertyFooterContainer
Container control for the page footers.
(Inherited from AbstractCMSPage.)
Protected propertyStatic memberGetFileEndRequest
When true, the request is completed, when false, the Request.End is called.
Public propertyHeaderActions
Local header actions
(Inherited from AbstractCMSPage.)
Public propertyHeight
Image height.
Public propertyIsCMSDesk
Determines whether the current page is located under the CMS Desk.
(Inherited from AbstractCMSPage.)
Public propertyIsDialog
Indicates whether page is a dialog. False by default.
(Inherited from AbstractCMSPage.)
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 propertyIsRootDialog
Indicates whether page is root dialog (top dialog page with header and footer)
(Inherited from AbstractCMSPage.)
Protected propertyIsStandardPage
If true, the page is a UI page
(Inherited from AbstractCMSPage.)
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 propertyLogsContainer
Container control for the log controls.
(Inherited from AbstractCMSPage.)
Public propertyManagersContainer
Container control for the page managers.
(Inherited from AbstractCMSPage.)
Public propertyMaxByteStream
Maximum streaming speed in bytes per second.
Public propertyMaxSideSize
Image maximum side size.
Public propertyMessagesPlaceHolder
Local page messages placeholder
(Inherited from AbstractCMSPage.)
Public propertyNodeID
Gets node ID of current document initialized from query string.
(Inherited from AbstractCMSPage.)
Public propertyOutputDataCacheItemName
Cache item name for the file output data.
Public propertyStatic memberRANGE_END Obsolete.
Range end constant
Public propertyStatic memberRANGE_START Obsolete.
Range start constant
Protected propertyStatic memberRangeRegExp
The range from HTTP header regular expression.
Public propertyRanges
2D Array in format {{START_RANGE,END_RANGE},{START_RANGE, END_RANGE}}.
Protected propertyRegisterGlobalHotKeyScript
Gets or sets the value that indicates whether global hotkey script should be registered
(Inherited from AbstractCMSPage.)
Public propertyResizeToDevice
Indicates if max side size parameter should be changes to device profile dimensions.
Public propertyRevalidateClientCache
Cache minutes.
Public propertyScriptManagerControl
Script manager control.
(Inherited from AbstractCMSPage.)
Protected propertySender
Gets or sets sender object that is used for writing data to the response.
Public propertyStatic memberSTREAM_LIMIT_SLEEP Obsolete.
Wait interval when stream limit was reached before next check.
Public propertyTabMode
Indicates if the page is in tab mode.
(Inherited from AbstractCMSPage.)
Public propertyTree
Tree provider object.
(Inherited from AbstractCMSPage.)
Public propertyUIContext
Page's UI context
(Inherited from AbstractCMSPage.)
Public propertyUseViewStateUserKey
If true, ViewStateUserKey is used.
(Inherited from AbstractCMSPage.)
Public propertyViewMode
View mode of the current page.
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
See Also