Class UploadboxProperties

Class UploadboxProperties.

Inheritance

System.Object

EJTagHelper

UploadboxProperties

Inherited Members

EJTagHelper.GetControlDetails(String)

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript.Models

Assembly: Syncfusion.EJ.dll

Syntax

public class UploadboxProperties : EJTagHelper

Constructors

UploadboxProperties()

Declaration

public UploadboxProperties()

Properties

AllowDragAndDrop

Enables the file drag and drop support to the Uploadbox control.

Declaration

[JsonProperty("allowDragAndDrop")]
public bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean	The allow drag and drop.

AsyncUpload

Uploadbox supports both synchronous and asynchronous upload. This can be achieved by using the asyncUpload property.Synchronous Upload - Selected files are sent to the application form post action.Asynchronous Upload - Selected files are sent to the server handler by using the AJAX Post.

Declaration

[JsonProperty("asyncUpload")]
public bool AsyncUpload { get; set; }

Property Value

Type	Description
System.Boolean	The async upload.

AutoUpload

Uploadbox supports auto uploading of files after the file selection is done.

Declaration

[JsonProperty("autoUpload")]
public bool AutoUpload { get; set; }

Property Value

Type	Description
System.Boolean	The auto upload.

BeforeRemove

Before the fileremove start, event will occur.

Declaration

[JsonProperty("beforeRemove")]
public string BeforeRemove { get; set; }

Property Value

Type	Description
System.String	The beforeRemove.

BeforeSend

Before the fileupload start, event will occur.

Declaration

[JsonProperty("beforeSend")]
public string BeforeSend { get; set; }

Property Value

Type	Description
System.String	The beforeSend.

Begin

Occurs when the upload progress begins.

Declaration

[JsonProperty("begin")]
public string Begin { get; set; }

Property Value

Type	Description
System.String	The begin.

Cancel

Occurs when the upload progress is cancelled.

Declaration

[JsonProperty("cancel")]
public string Cancel { get; set; }

Property Value

Type	Description
System.String	The cancel.

Complete

Occurs when the file upload progress is completed.

Declaration

[JsonProperty("complete")]
public string Complete { get; set; }

Property Value

Type	Description
System.String	The complete.

Create

Occurs when the Uploadbox control is created.

Declaration

[JsonProperty("create")]
public string Create { get; set; }

Property Value

Type	Description
System.String	The create.

CssClass

Sets the root class for the Uploadbox control theme. This cssClass API helps to use custom skinning option for the Uploadbox button and dialog content.

Declaration

[JsonProperty("cssClass")]
public string CssClass { get; set; }

Property Value

Type	Description
System.String	The css class.

CustomFileDetails

Specifies the custom file details in the dialog popup on initialization.

Declaration

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

Property Value

Type	Description
UploadboxCustomFileDetails	The custom file details.

Destroy

Occurs when the Uploadbox control is destroyed.

Declaration

[JsonProperty("destroy")]
public string Destroy { get; set; }

Property Value

Type	Description
System.String	The destroy.

DialogAction

Specifies the actions for dialog popup while initialization.

Declaration

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

Property Value

Type	Description
UploadboxDialogAction	The dialog action.

DialogPosition

Displays the Uploadbox dialog at the given X and Y positions. X: Dialog sets the left position value. Y: Dialog sets the top position value.

Declaration

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

Property Value

Type	Description
System.Object	The dialog position.

DragAreaText

Declaration

[Obsolete("The DragAreaText property has been deprecated.Use 'DropAreaText' instead of DragAreaText property.")]
public string DragAreaText { get; set; }

Property Value

Type	Description
System.String

DropAreaHeight

Specifies the dropAreaHeight when the draganddrop support is enabled in the Uploadbox control.

Declaration

[JsonProperty("dropAreaHeight")]
public string DropAreaHeight { get; set; }

Property Value

Type	Description
System.String	The drop area height.

DropAreaText

The dropAreaText is displayed when the drag and drop support is enabled in the Uploadbox control.

Declaration

[JsonProperty("dropAreaText")]
public string DropAreaText { get; set; }

Property Value

Type	Description
System.String	The drop area text.

DropAreaWidth

Specifies the dropAreaWidth when the draganddrop support is enabled in the Uploadbox control.

Declaration

[JsonProperty("dropAreaWidth")]
public string DropAreaWidth { get; set; }

Property Value

Type	Description
System.String	The drop area width.

Enabled

Based on the property value, Uploadbox is enabled or disabled.

Declaration

[JsonProperty("enabled")]
public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	The enabled.

EnableRTL

Sets the right-to-left direction property for the Uploadbox control.

Declaration

[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	The enable RTL.

Error

Occurs when the Upload process ends in Error.

Declaration

[JsonProperty("error")]
public string Error { get; set; }

Property Value

Type	Description
System.String	The error.

ExtensionsAllow

Only the files with the specified extension is allowed to upload. This is mentioned in the string format.

Declaration

[JsonProperty("extensionsAllow")]
public string ExtensionsAllow { get; set; }

Property Value

Type	Description
System.String	The extensions allow.

ExtensionsDeny

Only the files with the specified extension is denied for upload. This is mentioned in the string format.

Declaration

[JsonProperty("extensionsDeny")]
public string ExtensionsDeny { get; set; }

Property Value

Type	Description
System.String	The extensions deny.

FileSelect

Occurs when the file is selected for upload successfully.

Declaration

[JsonProperty("fileSelect")]
public string FileSelect { get; set; }

Property Value

Type	Description
System.String	The file select.

FileSize

Sets the maximum size limit for uploading the file. This is mentioned in the number format.

Declaration

[JsonProperty("fileSize")]
public double FileSize { get; set; }

Property Value

Type	Description
System.Double	The file size.

Height

Sets the height of the browse button.

Declaration

[JsonProperty("height")]
public string Height { get; set; }

Property Value

Type	Description
System.String	The height.

HtmlAttributes

Gets or sets the HTML attributes.

Declaration

[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	The HTML attributes.

InProgress

Occurs when the Upload process ends in progress.

Declaration

[JsonProperty("inProgress")]
public string InProgress { get; set; }

Property Value

Type	Description
System.String	The inprogress.

Locale

Configures the culture data and sets the culture to the Uploadbox.

Declaration

[JsonProperty("locale")]
public string Locale { get; set; }

Property Value

Type	Description
System.String	The locale.

MultipleFilesSelection

Enables multiple file selection for upload.

Declaration

[JsonProperty("multipleFilesSelection")]
public bool MultipleFilesSelection { get; set; }

Property Value

Type	Description
System.Boolean	The HTML multiple files selection.

Remove

Occurs when the uploaded file is removed successfully.

Declaration

[JsonProperty("remove")]
public string Remove { get; set; }

Property Value

Type	Description
System.String	The remove.

RemoveUrl

Specifies the remove action to be performed after the file uploading is completed. Here, mention the server address for removal.

Declaration

[JsonProperty("removeUrl")]
public string RemoveUrl { get; set; }

Property Value

Type	Description
System.String	The remove URL.

SaveUrl

Specifies the save action to be performed after the file is pushed for uploading. Here, mention the server address to be saved.

Declaration

[JsonProperty("saveUrl")]
public string SaveUrl { get; set; }

Property Value

Type	Description
System.String	The save URL.

ShowBrowseButton

Enables the browse button support to the Uploadbox control.

Declaration

[JsonProperty("showBrowseButton")]
public bool ShowBrowseButton { get; set; }

Property Value

Type	Description
System.Boolean	The show browse button.

ShowFileDetails

Specifies the file details to be displayed when selected for uploading. This can be done when the showFileDetails is set to true.

Declaration

[JsonProperty("showFileDetails")]
public bool ShowFileDetails { get; set; }

Property Value

Type	Description
System.Boolean	The show file deatils.

ShowRoundedCorner

Specifies the rounded corner.

Declaration

[JsonProperty("showRoundedCorner")]
public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean	The show rounded corner.

Success

Occurs when the file upload progress is successed.

Declaration

[JsonProperty("success")]
public string Success { get; set; }

Property Value

Type	Description
System.String	The success.

UploadBoxButtonText

Sets the text for each action button.

Declaration

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

Property Value

Type	Description
UploadboxButtonText	The button text.

UploadBoxDialogText

Property for applying the text to the Dialog title and content headers.

Declaration

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

Property Value

Type	Description
UploadboxDialogText	The dialog text.

UploadName

Sets the name for the Uploadbox control. This API helps to Map the action in code behind to retrieve the files.

Declaration

[JsonProperty("uploadName")]
public string UploadName { get; set; }

Property Value

Type	Description
System.String	The upload name.

Width

Sets the width of the browse button.

Declaration

[JsonProperty("width")]
public string Width { get; set; }

Property Value

Type	Description
System.String	The width.

Methods

GetControlDetails()

Get the control details

Declaration

protected override object GetControlDetails()

Returns

Type	Description
System.Object

Overrides

EJTagHelper.GetControlDetails()

ShouldSerializeUploadBoxButtonText()

ShouldSerialize method for UploadBoxButtonText.

Declaration

public bool ShouldSerializeUploadBoxButtonText()

Returns

Type	Description
System.Boolean

ShouldSerializeUploadBoxCustomFileDetails()

ShouldSerialize method for UploadBoxCustomFileDetails.

Declaration

public bool ShouldSerializeUploadBoxCustomFileDetails()

Returns

Type	Description
System.Boolean

ShouldSerializeUploadBoxDialogAction()

ShouldSerialize method for UploadBoxDialogAction.

Declaration

public bool ShouldSerializeUploadBoxDialogAction()

Returns

Type	Description
System.Boolean

ShouldSerializeUploadBoxDialogText()

ShouldSerialize method for UploadBoxDialogText.

Declaration

public bool ShouldSerializeUploadBoxDialogText()

Returns

Type	Description
System.Boolean