GetFilePage Class |
Namespace: CMS.UIControls
public abstract class GetFilePage : AbstractCMSPage
The GetFilePage type exposes the following members.
Name | Description | |
---|---|---|
GetFilePage |
Initializes a new instance of GetFilePage class.
|
Name | Description | |
---|---|---|
AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractCMSPage.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from AbstractCMSPage.) | |
AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractCMSPage.) | |
AddHeaderActions |
Adds the list of header actions to the page header actions.
(Inherited from AbstractCMSPage.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractCMSPage.) | |
AddMessage |
Adds text to existing message on the page.
(Inherited from AbstractCMSPage.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractCMSPage.) | |
CompleteRequest |
Completes the request.
| |
DisableDebugging |
Disables all debugging for current page
| |
EnsureFootersControl |
Ensures the page footer control.
(Inherited from AbstractCMSPage.) | |
EnsureScriptManager |
Ensures the script manager on the page.
(Inherited from AbstractCMSPage.) | |
ETagsMatch |
Responds with 304 Not Modified if ETags match and object has current timestamp.
| |
Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractCMSPage.) | |
EvalReturnType(String) |
Templated Eval, returns the value converted to specific type.
(Inherited from AbstractCMSPage.) | |
EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractCMSPage.) | |
EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractCMSPage.) | |
EvalDouble |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractCMSPage.) | |
EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractCMSPage.) | |
EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractCMSPage.) | |
EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractCMSPage.) | |
EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractCMSPage.) | |
EvalText |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractCMSPage.) | |
GetBaseCacheKey |
Returns the base cache key (created with all parameters considered to be valid for proper caching).
| |
GetCacheDependency |
Creates the cache dependency from the given keys.
| |
GetCachedOutputData |
Gets the cached data for the current request.
| |
GetDocumentManagerContainer |
Gets control ideal for containing document manager.
(Inherited from AbstractCMSPage.) | |
GetImageUrl |
Gets UI image URL.
(Inherited from AbstractCMSPage.) | |
GetObjectIconUrl | Obsolete.
Gets the icon for the given object type.
(Inherited from AbstractCMSPage.) | |
GetRange |
Parses the range header from the request.
| |
HandleDeviceDimension |
Handles max side size according to device profile dimensions.
| |
HandleDeviceResize |
Changes MaxSideSize to device dimensions if device resizing is enabled.
| |
CheckRequiredMimeType |
Checks if attachment mime type is allowed.
| |
InitDebug |
Initializes the debug controls.
(Inherited from AbstractCMSPage.) | |
InitDevTools |
Initializes the Dev tools menu
(Inherited from AbstractCMSPage.) | |
IsExtensionExcludedFromRanges |
Indicates if file with given extension is excluded from resumable downloads.
| |
LoadContextHelp |
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.) | |
LoadSiteName |
Loads the site name from the query string.
| |
LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractCMSPage.) | |
LogAndShowError |
Logs the exception and displays a general error message
(Inherited from AbstractCMSPage.) | |
NotFound |
File not found action.
| |
OnInit |
Init event handler.
(Overrides AbstractCMSPageOnInit(EventArgs).) | |
OnLoad |
Load event handler.
(Overrides ControlOnLoad(EventArgs).) | |
OnPreInit |
PreInit event handler.
(Overrides AbstractCMSPageOnPreInit(EventArgs).) | |
OnPreRender |
PreRender event handler.
(Overrides AbstractCMSPageOnPreRender(EventArgs).) | |
OnPreRenderComplete |
Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered.
(Inherited from AbstractCMSPage.) | |
OnUnload |
Unload event handler.
(Overrides ControlOnUnload(EventArgs).) | |
RegisterBodyModifyingScript |
Registers script that modified body element. (For IE7,8 compatibility reasons. See KB927917 for more information.)
(Inherited from AbstractCMSPage.) | |
RegisterContextHelpScript |
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.) | |
Render |
Render event handler.
(Overrides PageRender(HtmlTextWriter).) | |
ResolveUrl |
Resolves the given URL
(Inherited from AbstractCMSPage.) | |
RespondNotModified |
Responds with the not modified code.
| |
SaveOutputDataToCache |
Saves the data for current request to cache.
| |
SetCacheability |
Sets the cacheability with dependence on connection type
IE browser doesn't support No-Cache if current connection is secured
| |
SetDisposition |
Sets response header according to file type.
| |
SetFormAction |
Sets the form action for current page if was rewritten by URL rewriter
(Inherited from AbstractCMSPage.) | |
SetRevalidation |
Sets the revalidation of the client caches.
| |
SetTimeStamps |
Sets the last modified and expires header to the response
| |
ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractCMSPage.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.) | |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractCMSPage.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractCMSPage.) | |
ShowMessage |
Shows the specified message, optionally with a tooltip text and description.
(Inherited from AbstractCMSPage.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.) | |
ValidateCulture |
Validats the current request culture
| |
WriteBytes |
Streams the byte array to the response.
| |
WriteFile |
Streams the data file to the response.
|
Name | Description | |
---|---|---|
AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) | |
CallHandled |
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.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
LoadUserControl |
Loads the user control based on the given path
(Defined by ControlsExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Name | Description | |
---|---|---|
deviceResizeIsUsed |
Indicates if max resize for mobile device is used.
| |
mAllowCache |
If true, the caching is allowed.
| |
mCacheMinutes |
Cache minutes
| |
mClientCacheMinutes |
Client cache minutes
| |
mCompleted |
Indicates whether request is completed
| |
mContextMenuContainer |
Container control for the context menus.
(Inherited from AbstractCMSPage.) | |
mDocumentBase |
Document base.
| |
mDocumentManager |
Document manager control.
(Inherited from AbstractCMSPage.) | |
mFootersContainer |
Container control for the page footers.
(Inherited from AbstractCMSPage.) | |
mHeaderActions |
Header actions
(Inherited from AbstractCMSPage.) | |
mHeight |
Height
| |
mLogsContainer |
Container control for the log controls.
(Inherited from AbstractCMSPage.) | |
mManagersContainer |
Container control for the page managers.
(Inherited from AbstractCMSPage.) | |
mMaxByteStream |
Max. byte stream
| |
mMaxSideSize |
Max. side size
| |
mResizeToDevice |
Indicates whether resizing should be used for device
| |
mRevalidateClientCache |
Indicates whether client cache should be revalidated
| |
mScriptManagerControl |
Script manager control.
(Inherited from AbstractCMSPage.) | |
mViewMode |
View mode
| |
mWidth |
Width
| |
throw404WhenNotFound |
If true, 404 is thrown when the file is not found.
| |
useCacheItemName |
Cache item name for the request.
|
Name | Description | |
---|---|---|
AcceptRange |
Indicates if resumable downloads should be supported for current file.
| |
AcceptRanges |
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.
| |
AfterFormPlaceHolder |
Gets placeholder located after form element.
(Inherited from AbstractCMSPage.) | |
AllowCache |
Returns true if the process allows cache.
| |
AllowClientCache |
Returns true if client cache is allowed for the current request.
| |
AreRangesValid |
Indicates whether ranges are valid.
TRUE: ranges are valid or request is not range request
FALSE: all other cases
| |
BUFFER_SIZE | Obsolete.
Buffer size 64 kB.
| |
CacheItemName |
Cache item name for current request.
| |
CacheMinutes |
Cache minutes.
| |
ClientCacheMinutes |
Cache minutes.
| |
CONNECTION_CHECK | Obsolete.
Check connection every X buffering iterations.
| |
CONNECTION_TIMEOUT | Obsolete.
Connection timeout (seconds).
| |
ContextMenuContainer |
Container control for the context menus.
(Inherited from AbstractCMSPage.) | |
CultureCode |
Gets culture code of current document initialized from query string.
(Inherited from AbstractCMSPage.) | |
CurrentSite |
Current site.
| |
CurrentSiteName |
Current site name.
| |
CurrentUser |
Current User.
| |
CurrentUseXUACompatible |
If true, X-UA-Compatible header will be added to the page.
(Inherited from AbstractCMSPage.) | |
DataLength |
Size of data.
| |
DocumentBase |
Document base.
| |
DocumentID |
Gets document ID of current document initialized from query string.
(Inherited from AbstractCMSPage.) | |
DocumentManager |
Document manager control.
(Inherited from AbstractCMSPage.) | |
EnableContextHelp |
Tells you whether context help script generation into page is enabled.
(Inherited from AbstractCMSPage.) | |
EnsureDocumentManager |
Indicates if document manager should be ensured
(Inherited from AbstractCMSPage.) | |
EnsurePreferredCulture |
Indicates if content preferred culture should be ensured.
(Inherited from AbstractCMSPage.) | |
ETag |
HTTP header entity tag.
| |
ExcludedResumableExtensions |
List of file extensions for which the resumable downloads are disabled.
| |
FooterContainer |
Container control for the page footers.
(Inherited from AbstractCMSPage.) | |
GetFileEndRequest |
When true, the request is completed, when false, the Request.End is called.
| |
HeaderActions |
Local header actions
(Inherited from AbstractCMSPage.) | |
Height |
Image height.
| |
IsCMSDesk |
Determines whether the current page is located under the CMS Desk.
(Inherited from AbstractCMSPage.) | |
IsDialog |
Indicates whether page is a dialog.
False by default.
(Inherited from AbstractCMSPage.) | |
IsLiveSite |
Indicates if live site mode.
| |
IsMultipart |
Indicates whether it is multipart range request.
| |
IsRangeRequest |
Indicates whether it is range request.
| |
IsRootDialog |
Indicates whether page is root dialog (top dialog page with header and footer)
(Inherited from AbstractCMSPage.) | |
IsStandardPage |
If true, the page is a UI page
(Inherited from AbstractCMSPage.) | |
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.
| |
LogExceptions |
Logs the exceptions caused by the process.
| |
LogsContainer |
Container control for the log controls.
(Inherited from AbstractCMSPage.) | |
ManagersContainer |
Container control for the page managers.
(Inherited from AbstractCMSPage.) | |
MaxByteStream |
Maximum streaming speed in bytes per second.
| |
MaxSideSize |
Image maximum side size.
| |
MessagesPlaceHolder |
Local page messages placeholder
(Inherited from AbstractCMSPage.) | |
NodeID |
Gets node ID of current document initialized from query string.
(Inherited from AbstractCMSPage.) | |
OutputDataCacheItemName |
Cache item name for the file output data.
| |
RANGE_END | Obsolete.
Range end constant
| |
RANGE_START | Obsolete.
Range start constant
| |
RangeRegExp |
The range from HTTP header regular expression.
| |
Ranges |
2D Array in format {{START_RANGE,END_RANGE},{START_RANGE, END_RANGE}}.
| |
RegisterGlobalHotKeyScript |
Gets or sets the value that indicates whether global hotkey script should be registered
(Inherited from AbstractCMSPage.) | |
ResizeToDevice |
Indicates if max side size parameter should be changes to device profile dimensions.
| |
RevalidateClientCache |
Cache minutes.
| |
ScriptManagerControl |
Script manager control.
(Inherited from AbstractCMSPage.) | |
Sender |
Gets or sets sender object that is used for writing data to the response.
| |
STREAM_LIMIT_SLEEP | Obsolete.
Wait interval when stream limit was reached before next check.
| |
TabMode |
Indicates if the page is in tab mode.
(Inherited from AbstractCMSPage.) | |
Tree |
Tree provider object.
(Inherited from AbstractCMSPage.) | |
UIContext |
Page's UI context
(Inherited from AbstractCMSPage.) | |
UseViewStateUserKey |
If true, ViewStateUserKey is used.
(Inherited from AbstractCMSPage.) | |
ViewMode |
View mode of the current page.
| |
Watermark |
If set, watermark image is applied to the image. Name of the watermark image from ~/App_Themes/{theme}/Images/Watermarks
| |
WatermarkPosition |
Watermark position.
| |
Width |
Image width.
|