Click or drag to resize
FileUpload Class
Base class for file upload controls.
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23
Syntax
C#
public class FileUpload : CMSAdminControl

The FileUpload type exposes the following members.

Constructors
  NameDescription
Public methodFileUpload
Top
Methods
  NameDescription
Public methodAccessDenied(String)
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.)
Public methodAccessDenied(Int32, String)
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.)
Public methodAccessDenied(String, String)
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.)
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodClearForm
Clears control.
(Inherited from CMSAdminControl.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodGetAccessDeniedPageUrl
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetString
Returns localized string.
(Inherited from AbstractUserControl.)
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Protected methodCheckAllowedExtensions
Checks if file is allowed according current settings.
Public methodCheckPermissions(String, String)
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.)
Public methodCheckPermissions(String, String, Int32)
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.)
Public methodCheckPermissions(String, String, String)
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
OnLoad override, setup access denied page with dependence on current usage.
(Inherited from CMSUserControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Public methodRaiseOnCheckPermissions(String, CMSAdminControl)
Raises the OnCheckPermissions event, returns true when event was fired.
(Inherited from CMSAdminControl.)
Public methodRaiseOnCheckPermissions(String, String, CMSAdminControl)
Raises the OnCheckPermissions event, returns true when event was fired.
(Inherited from CMSAdminControl.)
Public methodRaiseOnNotAllowed
Raises the OnNotAllowed event.
(Inherited from CMSAdminControl.)
Public methodRedirectToAccessDenied(String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(Int32, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(String, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToUIElementAccessDenied
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSUserControl.)
Public methodReloadData
Reloads control data without force reload.
(Inherited from CMSAdminControl.)
Public methodReloadData(Boolean)
Reloads control data.
(Inherited from CMSAdminControl.)
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetContext
Sets the control context.
(Inherited from CMSUserControl.)
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
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 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 fieldmAccessDeniedPage
Access denied page
(Inherited from CMSUserControl.)
Protected fieldmCMSDeskAccessDeniedPage
CMSDesk access denied page
(Inherited from CMSUserControl.)
Protected fieldmControlContext
Control context
(Inherited from CMSUserControl.)
Protected fieldmControlGUID
Control GUID
(Inherited from CMSUserControl.)
Protected fieldmDisplayMode
Display mode
(Inherited from CMSUserControl.)
Protected fieldmErrorMessage
Error message.
(Inherited from CMSAdminControl.)
Protected fieldmInfoMessage
Information message.
(Inherited from CMSAdminControl.)
Protected fieldmRedirectToAccessDeniedPage
Redirect to access denied if the access is not allowed.
(Inherited from CMSAdminControl.)
Protected fieldmRelativePath
Relative path
(Inherited from CMSUserControl.)
Protected fieldmUseCMSDeskAccessDeniedPage
Indicates whether CMSDesk access denied page should be used
(Inherited from CMSUserControl.)
Protected fieldmViewStateTracked
If true, the ViewState has been already tracked.
(Inherited from InlineUserControl.)
Protected fieldproperties
Control properties.
(Inherited from InlineUserControl.)
Top
Properties
  NameDescription
Public propertyAccessDeniedPage
Access denied page URL.
(Inherited from CMSAdminControl.)
Public propertyAdditionalStyle
Additional style appended to generated style.
Public propertyAfterSaveJavascript
JavaScript function name called after save of new file.
Public propertyAllowedExtensions
Gets or sets which files with extensions are allowed to be uploaded.
Public propertyAttachmentGroupGUID
GUID of attachment group.
Public propertyAttachmentGUID
GUID of attachment.
Public propertyAttachmentGUIDColumnName
Name of document attachment column.
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyControlContext
Control context.
(Inherited from CMSUserControl.)
Public propertyControlGroup
Gets or sets control group of the control.
Public propertyControlGUID
Unique ID of the control within the given request.
(Inherited from CMSUserControl.)
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentResolver
Control's resolver
(Inherited from CMSUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDisplayInline
Indicates if the control should be displayed in inline mode.
Public propertyDisplayMode
Gets or sets display mode of the control.
(Inherited from CMSUserControl.)
Public propertyDocumentCulture
New document culture short name.
Public propertyDocumentID
ID of document.
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Public propertyErrorMessage
Error message.
(Inherited from CMSAdminControl.)
Public propertyFileUploadControl
File upload user control.
Public propertyForceLoad
Indicates whether control should set up in any case.
Public propertyFormGUID
GUID of form.
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyCheckPermissions
Indicates whether the permissions should be explicitly checked.
Public propertyIFrameUrl
URL of the IFrame uploader resides in.
Public propertyImageHeight
Height of upload image.
Public propertyImageUrl
URL of upload image.
Public propertyImageUrlOver
URL of upload image hover.
Public propertyImageWidth
Width of upload image.
Public propertyIncludeExtension
Indicates if file extension sould be included in file name.
Public propertyIncludeNewItemInfo
Indicates whether the post-upload JavaScript function call should include created attachment GUID information.
Public propertyInfoMessage
Information message.
(Inherited from CMSAdminControl.)
Public propertyInnerElementClass
CSS class of element containing upload button/icon.
Public propertyInnerLoadingElementClass
CSS class of element containing upload progress.
Public propertyInsertMode
Indicates if control is in insert mode (only new attachments are added, no update).
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyIsMediaThumbnail
Determines whether the uploader should upload media file thumbnail or basic media file.
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyLibraryFolderPath
Folder path of the current library.
Public propertyLibraryID
ID of the current library.
Public propertyLoadingImageUrl
URL of image shown when loading.
Public propertyMediaFileID
ID of the media file.
Public propertyMediaFileName
Media file name.
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyNodeClassName
Document class name.
Public propertyNodeGroupID
If set, NodeGroupID of content file is set also.
Public propertyNodeParentNodeID
Parent node ID.
Public propertyNodeSiteName
Current site name.
Public propertyOnlyImages
Indicates if only images is allowed for upload.
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Public propertyParentElemID
ID of parent element.
Public propertyPostedFile
Uploaded file.
Public propertyRaiseOnClick
Indicates if supported browser.
Public propertyRedirectToAccessDeniedPage
Redirect to access denied if the access is not allowed.
(Inherited from CMSAdminControl.)
Public propertyRelativePath
Page relative path.
(Inherited from CMSUserControl.)
Public propertyResizeToHeight
Height of attachment.
Public propertyResizeToMaxSideSize
Maximum side size of attachment.
Public propertyResizeToWidth
Width of attachment.
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertySourceType
Gets or sets type of the content uploaded by the control.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyTargetFileName
Target file name, to which will be used after files will be uploaded.
Public propertyTargetFilePath
Gets the target file path
Public propertyTargetFolderPath
Target folder path, to which physical files will be uploaded.
Public propertyText
Text displayed on uploader.
Public propertyTypeName
Returns the object type name.
(Inherited from CMSUserControl.)
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Public propertyUseCMSDeskAccessDeniedPage
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Public propertyVisible
Indicates whether the control is displayed.
(Overrides ControlVisible.)
Top
Events
  NameDescription
Public eventOnCheckPermissions
On check permissions event.
(Inherited from CMSAdminControl.)
Public eventOnCheckPermissionsExtended
On check permissions event.
(Inherited from CMSAdminControl.)
Public eventOnNotAllowed
On not allowed event.
(Inherited from CMSAdminControl.)
Top
See Also