UploaderHelper Class

Helper class for the file uploader.

Inheritance Hierarchy

System.Object
  CMS.Base.Web.UI.UploaderHelper

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 10.0.0

Syntax

public class UploaderHelper

The UploaderHelper type exposes the following members.

Constructors

	Name	Description
Public method	UploaderHelper	Default constructor.

Fields

	Name	Description
Public field Static member	UPLOAD_CHUNK_SIZE	Default size of the chunk in Bytes for uploader.

Properties

	Name	Description
Public property	AdditionalArgsCollection	NameValueCollection of the additional arguments.
Public property	AfterSaveJavascript	Name of the javascript function which should be fired on the client after the upload.
Public property	AfterScript	After script which will be evaluated after the upload.
Public property	AllowedExtensions	Extension which are allowed for uploaded files.
Public property	AttachmentArgs	Arguments for the attachment upload.
Public property	AttachmentArgsCollection	NameValueCollection of attachment arguments.
Public property	Canceled	Indicates whether the upload is canceled or not.
Public property	Complete	Indicates whether the upload is finished or not.
Public property	CurrentFileIndex	Current file index started from 1.
Public property	CurrentFileSize	Returns the whole size of currently uploaded file.
Public property	EventTarget	ClientID of the element which should be used for postback method as the target.
Public property	EventTargetPostbackReference	Gets postback reference for the event target.
Public property	Extension	Extension of the uploaded file.
Public property	FileArgs	Arguments for the file upload.
Public property	FileArgsCollection	NameValueCollection of file arguments.
Public property	FileName	Name of the uploaded file.
Public property	FilePath	Path to the uploaded file on the server in the temporary directory.
Public property	FilesCount	Count of currently uploading files.
Public property	ForumArgs	Arguments for the forum attachment upload.
Public property	ForumArgsCollection	NameValueCollection of forum arguments.
Public property	FullRefresh	Indicates whether the full refresh should be fired after the upload.
Public property	GetBytes	Indicates whether bytes should be got.
Public property	IncludeNewItemInfo	Indicates whether the info of the newly created item should be included in the after script.
Public property	InstanceGuid	Uploader instance guid.
Public property	IsAttachmentUpload	Indicates whether it is attachment upload.
Public property	IsFileUpload	Indicates whether it is file upload.
Public property	IsFirstUpload	Indicates if current upload is the first one.
Public property	IsForumAttachmentUpload	Indicates whether it is forum attachment upload.
Public property	IsInsertMode	Indicates whether the upload is running in the insert mode or not.
Public property	IsLastUpload	Indicates if current upload is last.
Public property	IsMediaLibraryUpload	Indicates whether it is media library upload.
Public property	IsMetaFileUpload	Indicates whether it is meta file upload.
Public property	IsPhysicalFileUpload	Indicates whether it is physical file upload.
Public property	MediaLibraryArgs	Arguments for the media library upload.
Public property	MediaLibraryArgsCollection	NameValueCollection of media library arguments.
Public property	Message	Error message displayed after upload.
Public property	MetaFileArgs	Arguments for the meta file upload.
Public property	MetaFileArgsCollection	NameValueCollection of meta file arguments.
Public property	Name	Name of the uploaded file without the file extension.
Public property	OnlyImages	Indicates whether only image files can be uploaded or not.
Public property	ParentElementID	ID of the parent element in which the upload control is placed.
Public property	RaiseOnClick	Indicates whether some script script should be raised on click event.
Public property	ResizeToHeight	Height to which should be image resized to.
Public property	ResizeToMaxSide	Max side size to which image should be resized to.
Public property	ResizeToWidth	Width to which should be image resized to.
Public property	SourceType	Gets or sets type of the content uploaded by the control.
Public property	StartByte	Specifies the start byte.
Public property	TargetFileName	Name of target file.
Public property	TargetFolderPath	Path to the target folder.
Public property Static member	TempPath	Path to the temporary directory used for all uploaded files.

Methods

	Name	Description
Public method	AddEventTargetPostbackReference	Adds postback reference to the after script if event target has been specified. This will ca.
Public method	CleanTempFile	Removes the temporary file.
Public method	CopyFile	Copies file from the source path to the destination path.
Public method	CheckNodePermissions	Check permissions.
Public method	IsExtensionAllowed	Checks if file is allowed according current settings. If it is not then error message is thrown.
Public method	ProcessFile	Processes the given data according to the uploader mode.