Class UploadboxPropertiesBuilder

Inheritance

System.Object

UploadboxPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

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

Assembly: Syncfusion.EJ.dll

Syntax

public class UploadboxPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

UploadboxPropertiesBuilder()

Initializes a new instance of the UploadboxPropertiesBuilder class.

Declaration

public UploadboxPropertiesBuilder()

UploadboxPropertiesBuilder(Uploadbox)

Initializes a new instance of the UploadboxPropertiesBuilder class.

Declaration

public UploadboxPropertiesBuilder(Uploadbox uploadbox)

Parameters

Type	Name	Description
Uploadbox	uploadbox	uploadbox

Fields

uploadbox

Creates a new instance of the Uploadbox class.

Declaration

public Uploadbox uploadbox

Field Value

Type	Description
Uploadbox

Methods

AllowDragAndDrop(Boolean)

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

Declaration

public UploadboxPropertiesBuilder AllowDragAndDrop(bool allowDragAndDrop)

Parameters

Type	Name	Description
System.Boolean	allowDragAndDrop

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

AsyncUpload()

Uploadbox supports both synchronous and asynchronous upload. This can be achieved by using the asyncUpload property.

Declaration

public UploadboxPropertiesBuilder AsyncUpload()

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

AsyncUpload(Boolean)

Uploadbox supports both synchronous and asynchronous upload. This can be achieved by using the asyncUpload property.A boolean variable asyncUpload is passed.

Declaration

public UploadboxPropertiesBuilder AsyncUpload(bool asyncUpload)

Parameters

Type	Name	Description
System.Boolean	asyncUpload	asyncUpload

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

AutoUpload()

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

Declaration

public UploadboxPropertiesBuilder AutoUpload()

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

AutoUpload(Boolean)

Uploadbox supports auto uploading of files after the file selection is done.A boolean variable autoUpload is passed.

Declaration

public UploadboxPropertiesBuilder AutoUpload(bool autoUpload)

Parameters

Type	Name	Description
System.Boolean	autoUpload	autoUpload

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

ClientSideEvents(Action<UploadboxClientSideEventsBuilder>)

Uploadbox ClientSideEvents

Declaration

public UploadboxPropertiesBuilder ClientSideEvents(Action<UploadboxClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<UploadboxClientSideEventsBuilder>	clientSideEvents	clientSideEvents

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns uploadbox properties builder value

CssClass(String)

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

public UploadboxPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass	cssClass

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

DragAreaText(String)

Declaration

[Obsolete("The DragAreaText property has been deprecated.Use 'DropAreaText' instead of DragAreaText property.")]
public UploadboxPropertiesBuilder DragAreaText(string DragAreaText)

Parameters

Type	Name	Description
System.String	DragAreaText

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

DropAreaHeight(String)

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

Declaration

public UploadboxPropertiesBuilder DropAreaHeight(string dropAreaHeight)

Parameters

Type	Name	Description
System.String	dropAreaHeight	dropAreaHeight

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

DropAreaText(String)

Declaration

public UploadboxPropertiesBuilder DropAreaText(string dropAreaText)

Parameters

Type	Name	Description
System.String	dropAreaText	dropAreaText

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

DropAreaWidth(String)

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

Declaration

public UploadboxPropertiesBuilder DropAreaWidth(string dropAreaWidth)

Parameters

Type	Name	Description
System.String	dropAreaWidth	dropAreaWidth

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

Enabled()

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

Declaration

public UploadboxPropertiesBuilder Enabled()

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

Enabled(Boolean)

Based on the property value, Uploadbox is enabled or disabled.A boolean variable enabled is passed.

Declaration

public UploadboxPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled	enabled

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

EnableRTL()

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

Declaration

public UploadboxPropertiesBuilder EnableRTL()

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

EnableRTL(Boolean)

Sets the right-to-left direction property for the Uploadbox control.A boolean variable enableRTL is passed.

Declaration

public UploadboxPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	enableRTL

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

ExtensionsAllow(String)

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

Declaration

public UploadboxPropertiesBuilder ExtensionsAllow(string extensionsAllow)

Parameters

Type	Name	Description
System.String	extensionsAllow	extensionsAllow

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

ExtensionsDeny(String)

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

Declaration

public UploadboxPropertiesBuilder ExtensionsDeny(string extensionsDeny)

Parameters

Type	Name	Description
System.String	extensionsDeny	extensionsDeny

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

FileSize(Double)

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

Declaration

public UploadboxPropertiesBuilder FileSize(double fileSize)

Parameters

Type	Name	Description
System.Double	fileSize	fileSize

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns number value

Height(String)

Sets the height of the browse button.

Declaration

public UploadboxPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height	height

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

HtmlAttributes(IDictionary<String, Object>)

Specifies the list of html attributes to be added to uploadbox control.

Declaration

public UploadboxPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	itemHtmlAttributes	itemHtmlAttributes

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns object value

Locale(String)

Sets the culture in the Upload when you set the localization values are needs to be assigned to the corresponding text as follows.

Declaration

public UploadboxPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale	locale

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

MultipleFilesSelection()

Enables multiple file selection for upload.

Declaration

public UploadboxPropertiesBuilder MultipleFilesSelection()

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

MultipleFilesSelection(Boolean)

Enables multiple file selection for upload.A boolean variable multipleFilesSelection is passed.

Declaration

public UploadboxPropertiesBuilder MultipleFilesSelection(bool multipleFilesSelection)

Parameters

Type	Name	Description
System.Boolean	multipleFilesSelection

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

Position(Action<PositionBuilder>)

Declaration

public UploadboxPropertiesBuilder Position(Action<PositionBuilder> position)

Parameters

Type	Name	Description
System.Action<PositionBuilder>	position	dialogPosition

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns object value

RemoveUrl(String)

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

Declaration

public UploadboxPropertiesBuilder RemoveUrl(string removeUrl)

Parameters

Type	Name	Description
System.String	removeUrl	removeUrl

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

Render()

Renders this instance.

Declaration

public void Render()

SaveUrl(String)

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

Declaration

public UploadboxPropertiesBuilder SaveUrl(string saveUrl)

Parameters

Type	Name	Description
System.String	saveUrl	saveUrl

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

ShowBrowseButton(Boolean)

Enables the browse button support to the Uploadbox control.

Declaration

public UploadboxPropertiesBuilder ShowBrowseButton(bool showBrowseButton)

Parameters

Type	Name	Description
System.Boolean	showBrowseButton	showBrowseButton

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

ShowFileDetails()

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

Declaration

public UploadboxPropertiesBuilder ShowFileDetails()

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

ShowFileDetails(Boolean)

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

Declaration

public UploadboxPropertiesBuilder ShowFileDetails(bool showFileDetails)

Parameters

Type	Name	Description
System.Boolean	showFileDetails	showFileDetails

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

ShowRoundedCorner()

Specifies the rounded corner in uploadbox.

Declaration

public UploadboxPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

ShowRoundedCorner(Boolean)

Specifies the rounded corner in uploadbox.

Declaration

public UploadboxPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner	showRoundedCorner

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns boolean value

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

UploadBoxButtonText(Action<UploadboxButtonTextBuilder>)

Sets the text for the Upload button inside the dialog popup.

Declaration

public UploadboxPropertiesBuilder UploadBoxButtonText(Action<UploadboxButtonTextBuilder> buttonText)

Parameters

Type	Name	Description
System.Action<UploadboxButtonTextBuilder>	buttonText	buttonText

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns object value

UploadBoxCustomFileDetails(Action<UploadboxCustomFileDetailsBuilder>)

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

Declaration

public UploadboxPropertiesBuilder UploadBoxCustomFileDetails(Action<UploadboxCustomFileDetailsBuilder> customFileDetails)

Parameters

Type	Name	Description
System.Action<UploadboxCustomFileDetailsBuilder>	customFileDetails	customFileDetails

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns object value

UploadBoxDialogAction(Action<UploadboxDialogActionBuilder>)

Specifies the actions for dialog popup while initialization.

Declaration

public UploadboxPropertiesBuilder UploadBoxDialogAction(Action<UploadboxDialogActionBuilder> dialogAction)

Parameters

Type	Name	Description
System.Action<UploadboxDialogActionBuilder>	dialogAction	dialogAction

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns object value

UploadBoxDialogText(Action<UploadboxDialogTextBuilder>)

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

Declaration

public UploadboxPropertiesBuilder UploadBoxDialogText(Action<UploadboxDialogTextBuilder> buttonText)

Parameters

Type	Name	Description
System.Action<UploadboxDialogTextBuilder>	buttonText	dialogText

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns object value

UploadName(String)

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

Declaration

public UploadboxPropertiesBuilder UploadName(string uploadName)

Parameters

Type	Name	Description
System.String	uploadName	uploadName

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

Width(String)

Sets the width of the browse button.

Declaration

public UploadboxPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width	width

Returns

Type	Description
UploadboxPropertiesBuilder	This method returns string value

Implements

IPropertiesBuilder

System.Web.IHtmlString