FileUpload Class

Base class for file upload controls.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.Base.Web.UI.InlineUserControl
            CMS.UIControls.CMSUserControl
              CMS.UIControls.CMSAdminControl
                CMS.UIControls.FileUpload
                  CMS.UIControls.DirectFileUploader

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 11.0.0

Syntax

public class FileUpload : CMSAdminControl

The FileUpload type exposes the following members.

Constructors

	Name	Description
Public method	FileUpload

Properties

	Name	Description
Public property	AdditionalStyle	Additional style appended to generated style.
Public property	AfterSaveJavascript	JavaScript function name called after save of new file.
Public property	AllowedExtensions	Gets or sets which files with extensions are allowed to be uploaded.
Public property	AttachmentGroupGUID	GUID of attachment group.
Public property	AttachmentGUID	GUID of attachment.
Public property	AttachmentGUIDColumnName	Name of document attachment column.
Public property	CheckPermissions	Indicates whether the permissions should be explicitly checked.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ControlContext	Control context. (Inherited from CMSUserControl.)
Public property	ControlGroup	Gets or sets control group of the control.
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentResolver	Control's resolver (Inherited from CMSUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DisplayInline	Indicates if the control should be displayed in inline mode.
Public property	DisplayMode	Gets or sets display mode of the control. (Inherited from CMSUserControl.)
Public property	DocumentCulture	New document culture short name.
Public property	DocumentID	ID of document.
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from CMSUserControl.)
Public property	ErrorMessage	Error message. (Inherited from CMSAdminControl.)
Public property	FileUploadControl	File upload user control.
Public property	ForceLoad	Indicates whether control should set up in any case.
Public property	FormGUID	GUID of form.
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	IFrameUrl	URL of the IFrame uploader resides in.
Public property	ImageHeight	Height of upload image.
Public property	ImageUrl	URL of upload image.
Public property	ImageUrlOver	URL of upload image hover.
Public property	ImageWidth	Width of upload image.
Public property	IncludeExtension	Indicates if file extension sould be included in file name.
Public property	IncludeNewItemInfo	Indicates whether the post-upload JavaScript function call should include created attachment GUID information.
Public property	InfoMessage	Information message. (Inherited from CMSAdminControl.)
Public property	InnerElementClass	CSS class of element containing upload button/icon.
Public property	InnerLoadingElementClass	CSS class of element containing upload progress.
Public property	InsertMode	Indicates if control is in insert mode (only new attachments are added, no update).
Public property	IsCMSDesk	Determines whether the current control lies on the page that is currently located under the CMS Desk. (Inherited from CMSUserControl.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	IsMediaThumbnail	Determines whether the uploader should upload media file thumbnail or basic media file.
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Public property	LibraryFolderPath	Folder path of the current library.
Public property	LibraryID	ID of the current library.
Public property	LoadingImageUrl	URL of image shown when loading.
Public property	MediaFileID	ID of the media file.
Public property	MediaFileName	Media file name.
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	NodeClassName	Document class name.
Public property	NodeGroupID	If set, NodeGroupID of content file is set also.
Public property	NodeParentNodeID	Parent node ID.
Public property	NodeSiteName	Current site name.
Public property	OnlyImages	Indicates if only images is allowed for upload.
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Public property	ParentElemID	ID of parent element.
Public property	PostedFile	Uploaded file.
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	RaiseOnClick	Indicates if supported browser.
Public property	RedirectToAccessDeniedPage	Redirect to access denied if the access is not allowed. (Inherited from CMSAdminControl.)
Public property	RelativePath	Obsolete. Page relative path. (Inherited from CMSUserControl.)
Public property	ResizeToHeight	Height of attachment.
Public property	ResizeToMaxSideSize	Maximum side size of attachment.
Public property	ResizeToWidth	Width of attachment.
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	SourceType	Gets or sets type of the content uploaded by the control.
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	TargetFileName	Target file name, to which will be used after files will be uploaded.
Public property	TargetFilePath	Gets the target file path
Public property	TargetFolderPath	Target folder path, to which physical files will be uploaded.
Public property	Text	Text displayed on uploader.
Public property	TypeName	Obsolete. Returns the object type name. (Inherited from CMSUserControl.)
Public property	UIContext	Control's UI Context (Inherited from CMSUserControl.)
Public property	UseCMSDeskAccessDeniedPage	Gets or sets the value that indicates whether CMSDesk access denied page should be used. (Inherited from CMSUserControl.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)

Methods

	Name	Description
Public method	AccessDenied(String)	Ensure access denied actions due to settings. (Inherited from CMSAdminControl.)
Public method	AccessDenied(Int32, String)	Ensure access denied actions due to settings. (Inherited from CMSAdminControl.)
Public method	AccessDenied(String, String)	Ensure access denied actions due to settings. (Inherited from CMSAdminControl.)
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Protected method	CheckAllowedExtensions	Checks if file is allowed according current settings.
Public method	CheckPermissions(String, String)	Check permissions for specified resource and permission type, return false is user doesn't have permissions. (Inherited from CMSAdminControl.)
Public method	CheckPermissions(String, String, Int32)	Check permissions for specified resource and permission type, return false is user doesn't have permissions. (Inherited from CMSAdminControl.)
Public method	CheckPermissions(String, String, String)	Check permissions for specified resource and permission type, return false is user doesn't have permissions. (Inherited from CMSAdminControl.)
Public method	ClearForm	Clears control. (Inherited from CMSAdminControl.)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDecimal	Evaluates the item data and converts it to the decimal. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Protected method	GetAccessDeniedPageUrl	Returns access denied page with dependence on current setting. (Inherited from CMSUserControl.)
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	GetValue(String)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	Load event handler. (Inherited from AbstractUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Public method	RaiseOnCheckPermissions(String, CMSAdminControl)	Raises the OnCheckPermissions event, returns true when event was fired. (Inherited from CMSAdminControl.)
Public method	RaiseOnCheckPermissions(String, String, CMSAdminControl)	Raises the OnCheckPermissions event, returns true when event was fired. (Inherited from CMSAdminControl.)
Public method	RaiseOnNotAllowed	Raises the OnNotAllowed event. (Inherited from CMSAdminControl.)
Public method	RedirectToAccessDenied(String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(Int32, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(String, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToUIElementAccessDenied	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Public method	ReleaseContext	Releases the control context. (Inherited from CMSUserControl.)
Public method	ReloadData()	Reloads control data without force reload. (Inherited from CMSAdminControl.)
Public method	ReloadData(Boolean)	Reloads control data. (Inherited from CMSAdminControl.)
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SetContext	Sets the control context. (Inherited from CMSUserControl.)
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)

Extension Methods

	Name	Description
Public Extension Method	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.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnCheckPermissions	On check permissions event. (Inherited from CMSAdminControl.)
Public event	OnCheckPermissionsExtended	On check permissions event. (Inherited from CMSAdminControl.)
Public event	OnNotAllowed	On not allowed event. (Inherited from CMSAdminControl.)