Class UploadBox

Represents the UploadBox UI element.

Inheritance

System.Object

CommonControl

UploadBox

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonControl.RaisePostBackEvent(String)

CommonControl.OnInit(EventArgs)

CommonControl.OnLoad(EventArgs)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class UploadBox : CommonControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

UploadBox()

Declaration

public UploadBox()

Properties

AllowDragAndDrop

Gets or sets a value indicating whether [allow drag and drop].

Declaration

public bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean	true if [allow drag and drop]; otherwise, false.

AsyncUpload

Gets or sets a value indicating whether [asynchronous upload].

Declaration

public bool AsyncUpload { get; set; }

Property Value

Type	Description
System.Boolean	true if [asynchronous upload]; otherwise, false.

AutoUpload

Gets or sets a value indicating whether [automatic upload].

Declaration

public bool AutoUpload { get; set; }

Property Value

Type	Description
System.Boolean	true if [automatic upload]; otherwise, false.

ClientSideOnBeforeRemove

Occurs before the uploaded file is removed successfully.

Declaration

public string ClientSideOnBeforeRemove { get; set; }

Property Value

Type	Description
System.String	The client side on before remove.

ClientSideOnBeforeSend

Occurs when the upload progress begins.

Declaration

public string ClientSideOnBeforeSend { get; set; }

Property Value

Type	Description
System.String	The client side on begin.

ClientSideOnBegin

Occurs when the upload progress begins.

Declaration

public string ClientSideOnBegin { get; set; }

Property Value

Type	Description
System.String	The client side on begin.

ClientSideOnCancel

Occurs when the upload progress is cancelled.

Declaration

public string ClientSideOnCancel { get; set; }

Property Value

Type	Description
System.String	The client side on cancel.

ClientSideOnComplete

Occurs when the file upload progress is completed.

Declaration

public string ClientSideOnComplete { get; set; }

Property Value

Type	Description
System.String	The client side on complete.

ClientSideOnCreate

Occurs when the Uploadbox control is created.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String	The client side on create.

ClientSideOnDestroy

Occurs when the Uploadbox control is destroyed.

Declaration

public string ClientSideOnDestroy { get; set; }

Property Value

Type	Description
System.String	The client side on destroy.

ClientSideOnError

Occurs when the Upload process ends in Error.

Declaration

public string ClientSideOnError { get; set; }

Property Value

Type	Description
System.String	The client side on error.

ClientSideOnFileSelect

Occurs when the file is selected for upload successfully.

Declaration

public string ClientSideOnFileSelect { get; set; }

Property Value

Type	Description
System.String	The client side on file select.

ClientSideOnInProgress

Occurs when the Upload process ends in progress.

Declaration

public string ClientSideOnInProgress { get; set; }

Property Value

Type	Description
System.String	The client side on in progress.

ClientSideOnRemove

Occurs when the uploaded file is removed successfully.

Declaration

public string ClientSideOnRemove { get; set; }

Property Value

Type	Description
System.String	The client side on remove.

ClientSideOnSuccess

Occurs when the file upload progress is successed.

Declaration

public string ClientSideOnSuccess { get; set; }

Property Value

Type	Description
System.String	The client side on success.

CssClass

Gets or sets the CSS class.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The CSS class.

CustomFileDetails

Gets or sets the custom file details.

Declaration

[JsonProperty("CustomFileDetails")]
public UploadboxCustomFileDetails CustomFileDetails { get; set; }

Property Value

Type	Description
UploadboxCustomFileDetails	The custom file details.

DialogAction

Gets or sets the dialog action.

Declaration

[JsonProperty("dialogAction")]
public UploadboxDialogAction DialogAction { get; set; }

Property Value

Type	Description
UploadboxDialogAction	The dialog action.

DialogPosition

Gets or sets the dialog position.

Declaration

[JsonProperty("dialogPosition")]
public Position DialogPosition { get; set; }

Property Value

Type	Description
Position	The dialog position.

DragAreaText

Gets or sets the drop area text.

Declaration

[Obsolete("Property has been deprecated with DropAreaText.")]
public string DragAreaText { get; set; }

Property Value

Type	Description
System.String	The drop area text.

DropAreaHeight

Gets or sets the height of the drop area.

Declaration

public string DropAreaHeight { get; set; }

Property Value

Type	Description
System.String	The height of the drop area.

DropAreaText

Gets or sets the drop area text.

Declaration

public string DropAreaText { get; set; }

Property Value

Type	Description
System.String	The drop area text.

DropAreaWidth

Gets or sets the width of the drop area.

Declaration

public string DropAreaWidth { get; set; }

Property Value

Type	Description
System.String	The width of the drop area.

Enabled

Gets or sets a value indicating whether this UploadBox is enabled.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	true if enabled; otherwise, false.

EnableRTL

Gets or sets a value indicating whether [enable RTL].

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	true if [enable RTL]; otherwise, false.

ExtensionsAllow

Gets or sets the extensions allow.

Declaration

public string ExtensionsAllow { get; set; }

Property Value

Type	Description
System.String	The extensions allow.

ExtensionsDeny

Gets or sets the extensions deny.

Declaration

public string ExtensionsDeny { get; set; }

Property Value

Type	Description
System.String	The extensions deny.

FileSize

Gets or sets the size of the file.

Declaration

public string FileSize { get; set; }

Property Value

Type	Description
System.String	The size of the file.

HasFiles

Gets a value indicating whether this instance has files.

Declaration

public bool HasFiles { get; }

Property Value

Type	Description
System.Boolean	true if this instance has files; otherwise, false.

Height

Gets or sets the height.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The height.

Locale

Gets or sets the locale.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The locale.

Model

Gets or sets the Uploadbox property to its model

Declaration

public UploadboxProperties Model { get; set; }

Property Value

Type	Description
UploadboxProperties

MultipleFilesSelection

Gets or sets a value indicating whether [multiple files selection].

Declaration

public bool MultipleFilesSelection { get; set; }

Property Value

Type	Description
System.Boolean	true if [multiple files selection]; otherwise, false.

PostedFiles

Gets the posted files.

Declaration

public IList<HttpPostedFile> PostedFiles { get; }

Property Value

Type	Description
System.Collections.Generic.IList<System.Web.HttpPostedFile>	The posted files.

RemoveUrl

Gets or sets the remove URL.

Declaration

public string RemoveUrl { get; set; }

Property Value

Type	Description
System.String	The remove URL.

SaveUrl

Gets or sets the save URL.

Declaration

public string SaveUrl { get; set; }

Property Value

Type	Description
System.String	The save URL.

ShowBrowseButton

Gets or sets a value indicating whether [show browse button].

Declaration

public bool ShowBrowseButton { get; set; }

Property Value

Type	Description
System.Boolean	true if [show browse button]; otherwise, false.

ShowFileDetails

Gets or sets a value indicating whether [show file details].

Declaration

public bool ShowFileDetails { get; set; }

Property Value

Type	Description
System.Boolean	true if [show file details]; otherwise, false.

ShowRoundedCorner

Gets or sets a value indicating whether [show rounded corner].

Declaration

public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean	true if [show rounded corner]; otherwise, false.

UploadBoxButtonText

Gets or sets the upload box button text.

Declaration

[JsonProperty("buttonText")]
public UploadboxButtonText UploadBoxButtonText { get; set; }

Property Value

Type	Description
UploadboxButtonText	The upload box button text.

UploadBoxDialogText

Gets or sets the upload box dialog text.

Declaration

[JsonProperty("dialogText")]
public UploadboxDialogText UploadBoxDialogText { get; set; }

Property Value

Type	Description
UploadboxDialogText	The upload box dialog text.

UploadName

Gets or sets the name of the upload.

Declaration

public string UploadName { get; set; }

Property Value

Type	Description
System.String	The name of the upload.

Width

Gets or sets the width.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The width.

Methods

DependentScripts()

Represents the dependent scripts for Uploadbox control.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	This method returns the list of dependent script files which is of type string

GetDependentFiles()

Get the dependent files for UploadBox control

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>

Overrides

CommonControl.GetDependentFiles()

LoadViewState(Object)

Restores view-state information from a previous page request.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state

Overrides

CommonControl.LoadViewState(Object)

OnPreRender(EventArgs)

Modifying server controls before sending them to the client.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

PostBackEventHandler(String, Dictionary<String, Object>)

Gets a value that indicates whether the page is being loaded in response to a postback.

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Render this instance

Declaration

public string Render()

Returns

Type	Description
System.String

Render(HtmlTextWriter)

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonControl.Render(HtmlTextWriter)

UpdateServerModel(Dictionary<String, Object>)

Maintaining viewstate model values on post back

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonControl.UpdateServerModel(Dictionary<String, Object>)

Events

Complete

Occurs when [complete].

Declaration

public event UploadBox.UploadBoxCompleteEventHandler Complete

Event Type

Type	Description
UploadBox.UploadBoxCompleteEventHandler

ErrorFile

Occurs when [error file].

Declaration

public event UploadBox.UploadBoxErrorFileEventHandler ErrorFile

Event Type

Type	Description
UploadBox.UploadBoxErrorFileEventHandler

RemoveFile

Occurs when [remove file].

Declaration

public event UploadBox.UploadBoxRemoveFileEventHandler RemoveFile

Event Type

Type	Description
UploadBox.UploadBoxRemoveFileEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

See Also

CommonControl