Upload

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • Upload

Represent an upload widget. Allows users to selected one or more files and upload them to the server.

C#

public class Upload : Control, IWisejHandler, IValidation

VB.NET

Public Class Upload
    Inherits Control
    Implements IWisejHandler, IValidation

Constructors

Upload()

Initializes a new instance of Upload.

Properties

AllowedFileTypes

String: Specify the types of files that the server accepts (that can be submitted through a file upload). (Default: "")

The allowed files string follows the HTML 4.01 and HTML5 specifications. You can configure only one entry in the browser's file dialog. The syntax is "file_extension|audio/|video/|image/*|media_type" where

• file_extension A file extension starting with the dot, e.g: .gif, .jpg, .png, .doc.
• audio/* All sound files are accepted
• video/* All video files are accepted
• image/* All image files are accepted
• media_type A valid media type, with no parameters. Look at IANA Media Types for a complete list of standard media types.

AllowFolders

Boolean: Returns or sets whether the upload control allows the selection of a directory for upload. (Default: False)

AllowMultipleFiles

Boolean: Returns or sets whether the upload control allows the selection of multiple files. (Default: False)

ButtonPosition

ContentAlignment: Returns or sets the position of the upload button relative to the value field.. (Default: MiddleRight)

CaptureMode

CaptureMode: Returns or sets a value that specifies which camera to use for capture of image or video data, if the AllowedFileTypes property indicates that the input should be of one of those types. (Default: Default)

DefaultSize

Size:

HideValue

Boolean: Returns or sets whether the value field is visible. (Default: False)

Image

Image: Returns or sets the icon that is displayed in the upload button in the Upload control.

ImageSource

String: Returns or sets the theme name or URL for the icon to display in the upload button in the Upload control.

Invalid

Boolean: Returns or sets a value that indicates that the control is invalid.

InvalidMessage

String: Returns or sets the invalid message that is shown in the invalid tooltip. (Default: "")

MaxFileSize

Int32: Returns or sets the maximum file size in bytes. (Default: 0)

Throws:

• ArgumentException The value specified is less than 0.

ShowLoader

Boolean: Returns or sets whether the upload control shows a the ajax-loader image when uploading the file(s). (Default: True)

Text

String: Returns or sets the text associated with this control. (Default: "")

TextAlign

ContentAlignment: Returns or sets the alignment of the text on the button control. (Default: MiddleCenter)

Value

String: Returns or sets the text to display in the text fields part of the control. (Default: "")

Methods

Abort()

Aborts the current upload request, if in progress.

OnError(e)

Fires the Error event.

Parameter	Type	Description
e	UploadErrorEventArgs	A UploadErrorEventArgs that contains the event data.

OnProgress(e)

Fires the Progress event.

Parameter	Type	Description
e	UploadProgressEventArgs	A UploadProgressEventArgs that contains the event data.

This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

OnUploaded(e)

Fires the Uploaded event.

Parameter	Type	Description
e	UploadedEventArgs	A UploadedEventArgs that contains the event data.

OnUploading(e)

Fires the Uploading event.

Parameter	Type	Description
e	UploadingEventArgs	A UploadingEventArgs that contains the event data.

This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

OnValueChanged(e)

Fires the ValueChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

UploadFiles()

Opens the file selection dialog and uploads the files selected by the user.

Events

Error

UploadErrorEventHandler Fired when the Upload control generates an upload error.

Progress

UploadProgressEventHandler Fired while the Upload control receives the data being uploaded.

This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

Uploaded

UploadedEventHandler Fired when files are uploaded to the Upload control.

Uploading

UploadingEventHandler Fired before the Upload control received the files being uploaded.

This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.

You can abort the uploading process by setting e.Cancel = true in the event handler.

ValueChanged

EventHandler Fired when the user has selected the files to upload.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
IValidation	Provides access to the validation events and properties property for controls that support validation.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejHandler	Represents a Wisej component that is capable of handling postback requests from the client.
IWisejSerializable	Allows an object to serialize itself.