RadAsyncUpload

Gets or sets the allowed file extensions for uploading.

[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public string[] AllowedFileExtensions { get; set; }

Property Value:

The default value is empty string array. In order to check for multiple file extensions you should set an array of strings containing the allowed file extensions for uploading.

Set this property to empty array of strings in order to prevent the file extension checking.

Example:

cs-api-definition
Dim allowedFileExtensions As String() = New String(2) {"zip", "doc", "config"}
RadAsyuncUpload1.AllowedFileExtensions = allowedFileExtensions
cs-api-definition.skip-repl
string[] allowedFileExtensions = new string[3] {"zip", "doc", "config"};
RadAsyncUpload1.AllowedFileExtensions = allowedFileExtensions;

AllowedMimeTypes

Gets or sets the allowed MIME types for uploading.

[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public string[] AllowedMimeTypes { get; set; }

Property Value:

The default value is empty string array. In order to check for multiple mime types you should set an array of strings containing the allowed MIME types for uploading.

Set this property to string.Empty in order to prevent the mime type checking.

Example:

cs-api-definition
' For example you can Get these from your web.config file
Dim commaSeparatedMimeTypes As String = "application/octet-stream,application/msword,video/mpeg"

Dim allowedMimeTypes As String() = commaSeparatedMimeTypes.Split(",")
RadAsyncUpload1.AllowedMimeTypes = allowedMimeTypes
cs-api-definition.skip-repl
// For example you can get these from your web.config file
string commaSeparatedMimeTypes = "application/octet-stream,application/msword,video/mpeg";

string[] allowedMimeTypes = commaSeparatedMimeTypes.Split(',');
RadAsyncUpload1.AllowedMimeTypes = allowedMimeTypes;

AriaSettings

WaiAriaSettings

Gets the object that controls the Wai-Aria settings applied on the control's input element.

[PersistenceMode(PersistenceMode.InnerProperty)]
public WaiAriaSettings AriaSettings { get; }

AutoAddFileInputs

Specifies whether a new File Input should be automatically added upon selecting a file to upload.

[ClientControlProperty]
[ClientPropertyName("_autoAddFileInputs")]
public bool AutoAddFileInputs { get; set; }

ChunkSize

Gets or sets the size of the uploading chunks in bytes.

[PersistenceMode(PersistenceMode.Attribute)]
public int ChunkSize { get; set; }

Property Value:

The default value is 2097152(2MB).

When FileApi upload module is used the selected files are uploading on chunks and the property set theirs size.

ControlObjectsVisibility

Gets or sets the control objects visibility.

[Browsable(false)]
[Bindable(true)]
[Obsolete("This property is obsolete in RadAsyncUpload")]
public virtual ControlObjectsVisibility ControlObjectsVisibility { get; set; }

Property Value:

The control objects visibility.

CssClassFormatString

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

Example:

protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

DropZones

Gets or sets the drop zones for upload.

[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public string[] DropZones { get; set; }

The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element.

EnableAriaSupport

When set to true enables support for WAI-ARIA.

[ClientControlProperty]
[ClientPropertyName("enableAriaSupport")]
public bool EnableAriaSupport { get; set; }

EnableCustomValidation

Gets or sets whether to fire the FileUploaded event and process the files if the Page is valid, after the server side validation events.

[PersistenceMode(PersistenceMode.Attribute)]
public bool EnableCustomValidation { get; set; }

The control will fires its event and process the files if the Page is valid, after the server side validation events. If the Page is not valid the uploaded files are persisted between postbacks.

EnableFileInputSkinning

Gets or sets the value indicating whether the file input fields skinning will be enabled.

[Browsable(true)]
[Bindable(true)]
[ClientPropertyName("enableFileInputSkinning")]
[ClientControlProperty]
public bool EnableFileInputSkinning { get; set; }

Property Value:

true when the file input skinning is enabled; otherwise false.

The <input type=file> DHTML elements are not skinnable by default. If the EnableFileInputSkinning is true some browsers can have strange behavior.

EnableHandlerDetection

Gets or sets a value indicating if RadAsyncUpload should check the Telerik.Web.UI.WebResource handler existence in the application configuration file.

public bool EnableHandlerDetection { get; set; }

The check is not performed when custom handler is used.

EnableInlineProgress

Specifies whether RadAsyncUpload displays an inline progress next to each file being uploaded.

[ClientControlProperty]
[ClientPropertyName("_enableInlineProgress")]
public bool EnableInlineProgress { get; set; }

Property Value:

The default value is false

The InlineProgress is turned on by default. If you have RadProgressArea on the page both the area and the inline progress are going to be shown. In order to suppress the InlineProgress, consider setting the property to false.

EnablePermissionsCheck

Specifies whether RadAsyncUpload performs check for write permissions upon load

public bool EnablePermissionsCheck { get; set; }

Property Value:

The default value is true

The permissions check is turned on by default. You should disable it if you plan to upload the files directly to the handler without using the temporary folder. If you still want to use temporary folder make sure that you have set the TemporyFilesFolder property to a folder that has write permissions for the

FileFilters

FileFilterCollection

Gets the collection of FileFilter objects to be applied to the OpenFileDialog

[PersistenceMode(PersistenceMode.InnerProperty)]
public FileFilterCollection FileFilters { get; }

Property Value:

A FileFilterCollection containing FileFilter object that define the filters applied to the OpenFileDialog

FilterFormatter

protected FilterFormatter FilterFormatter { get; }

HideFileInput

Gets or sets whether to render the file input.

[PersistenceMode(PersistenceMode.Attribute)]
[ClientControlProperty]
[ClientPropertyName("_hideFileInput")]
public bool HideFileInput { get; set; }

When HideFileInput is set to True, only the select button will be rendered.

InitialFileInputsCount

Gets or sets the initial count of file input fields, which will appear in RadAsyncUpload.

[Browsable(true)]
[Bindable(true)]
[ClientPropertyName("initialFileInputsCount")]
[ClientControlProperty]
public int InitialFileInputsCount { get; set; }

Property Value:

The file inputs count which will be available at startup. The default value is 1.

KeyboardNavigationSettings

Used to customize the Navigation keyboard navigation functionality.

[PersistenceMode(PersistenceMode.InnerProperty)]
public KeyboardNavigationSettings KeyboardNavigationSettings { get; }

MaxFileInputsCount

Gets or sets the maximum file input fields that can be added to the control.

[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
[ClientPropertyName("maxFileCount")]
[ClientControlProperty]
public int MaxFileInputsCount { get; set; }

Property Value:

The default value is 0 (unlimited).

Using this property you can limit the maximum number of file inputs which can be added to a RadAsyncUpload instance. MaxFileInputs count is only applicable when MultipleFileSelection is set to Disabled

MaxFileSize

Gets or sets the maximum file size allowed for uploading in bytes.

[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
[ClientControlProperty]
[ClientPropertyName("_maxFileSize")]
public int MaxFileSize { get; set; }

Property Value:

The default value is 0 (unlimited).

Set this property to 0 in order to prevent the file size checking.

MultipleFileSelection

Specifies whether RadAsyncUpload allows selecting multiple files in the File Selection dialog.

[ClientControlProperty]
[ClientPropertyName("_multipleFileSelection")]
public MultipleFileSelection MultipleFileSelection { get; set; }

Property Value:

The default value is Disabled

Setting the MultipleFileSelection property to Automatic means that RadAsyncUpload will check the client's browser capabilities and if there is support for multiple file selection he will enable it. If there is no such support, the selection type would be still single.

OnClientAdded

Gets or sets the name of the client-side function which will be executed after a new file input is added to a RadAsyncUpload instance. The event cannot be cancelled

[Browsable(true)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("added")]
public string OnClientAdded { get; set; }

Property Value:

The default value is string.Empty.

OnClientAdding

Gets or sets the name of the client-side function which will be executed before a new file input is added to a RadAsyncUpload instance. This event can be cancelled.

[Browsable(false)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("adding")]
protected string OnClientAdding { get; set; }

Property Value:

The default value is string.Empty.

OnClientFileDropped

Gets or sets the name of the client-side function which will be executed after a file has been dropped.

[Browsable(true)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("fileDropped")]
public string OnClientFileDropped { get; set; }

Property Value:

The default value is string.Empty.

OnClientFileSelected

Gets or sets the name of the client-side function which will be executed after a file has been selected.

[Browsable(true)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("fileSelected")]
public string OnClientFileSelected { get; set; }

Property Value:

The default value is string.Empty.

OnClientFilesSelected

Gets or sets the name of the client-side function which will be executed after files have been selected. This event can be cancelled.

[Browsable(true)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("filesSelected")]
public string OnClientFilesSelected { get; set; }

Property Value:

The default value is string.Empty.

OnClientFilesUploaded

Gets or sets the name of the client-side function which will be executed after all selected files have been uploaded

[Browsable(true)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("filesUploaded")]
public string OnClientFilesUploaded { get; set; }

Property Value:

The default value is string.Empty.

OnClientFileUploaded

Gets or sets the name of the client-side function which will be executed when a file upload finishes successfully.k

[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("fileUploaded")]
public string OnClientFileUploaded { get; set; }

Property Value:

The default value is string.Empty.

If specified, the OnClientFileUploaded client-side event is called when file is uploaded successfully.
sender, the async upload client object;
eventArgs with one property:
get_fileName(), the name of the file that was uploaded.

This event cannot be cancelled.

Example:

<p>&lt;script type="text/javascript"&gt;<br />
function onClientFileUploaded(sender, eventArgs)<br />
{<br />
       var fileName = eventArgs.get_fileName();<br />
}<br />
&lt;/script&gt;</p>
<p>&lt;telerik:RadAsyncUpload ID="RadAsyncUpload1"<br />
runat="server"<br />
    <strong>OnClientFileUploaded="onClientFileUploaded"</strong>&gt;<br />
....<br />
&lt;/telerik:RadAsyncUpload&gt;</p>

OnClientFileUploadFailed

Gets or sets the name of the client-side function which will be executed when a file upload ends unsuccessfully.

[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("fileUploadFailed")]
public string OnClientFileUploadFailed { get; set; }

Property Value:

The default value is string.Empty.

If specified, the OnClientFileUploadFailed client-side event is called when a file fails to upload. One can set the set_handled property to false which will force the async upload to throw an exception the error message to the JavaScript console.
sender, the async upload client object;
eventArgs with three properties:
get_message(), the error message containing the reason for the failed upload
get_handled(), gets a value indicating whether the developer will handle the error
set_handled(), sets a value indicating whether the developer will handle the error

This event cannot be cancelled.

Example:

<p>&lt;script type="text/javascript"&gt;<br />
function onClientFileUploadFailed(sender, eventArgs)<br />
{<br />
       var message = eventArgs.get_message();<br />
}<br />
&lt;/script&gt;</p>
<p>&lt;telerik:RadAsyncUpload ID="RadAsyncUpload1"<br />
runat="server"<br />
    <strong>OnClientFileUploadFailed="onClientFileUploadFailed"</strong>&gt;<br />
....<br />
&lt;/telerik:RadAsyncUpload&gt;</p>

OnClientFileUploading

Gets or sets the name of the client-side function which will be executed when a file upload starts.

[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("fileUploading")]
public string OnClientFileUploading { get; set; }

Property Value:

The default value is string.Empty.

If specified, the OnClientFileUploading client-side event is called whenever a file upload commences.
sender, the async upload client object;
eventArgs with one property:
get_fileName(), the name of the file being uploaded.

This event cannot be cancelled.

Example:

<p>&lt;script type="text/javascript"&gt;<br />
function onClientFileUploading(sender, eventArgs)<br />
{<br />
       var fileName = eventArgs.get_fileName();<br />
}<br />
&lt;/script&gt;</p>
<p>&lt;telerik:RadAsyncUpload ID="RadAsyncUpload1"<br />
runat="server"<br />
    <strong>OnClientFileUploading="onClientFileUploading"</strong>&gt;<br />
....<br />
&lt;/telerik:RadAsyncUpload&gt;</p>

OnClientFileUploadRemoved

Gets or sets the name of the client-side function which will be executed after a file input has been deleted from a RadAsyncUpload instance.

[Browsable(true)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("fileUploadRemoved")]
public string OnClientFileUploadRemoved { get; set; }

Property Value:

The default value is string.Empty.

OnClientFileUploadRemoving

Gets or sets the name of the client-side function which will be executed before a file input is deleted from a RadAsyncUpload instance. The event can be cancelled.

[Browsable(true)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("fileUploadRemoving")]
public string OnClientFileUploadRemoving { get; set; }

Property Value:

The default value is string.Empty.

If you want to cancel the deleting of the file input return false in the javascript handler.

Example:

cs-api-definition
&lt;radU:RadAsyncUpload OnClientFileUploadDeleting="myOnClientDeleting" ... /&gt;
&lt;script language="javascript"&gt;
function myOnClientDeleting()
{
args.set_cancel(prompt("Are you sure?"));
}
&lt;/script&gt;
cs-api-definition.skip-repl
&lt;radU:RadAsyncUpload OnClientFileUploadingDeleting="myOnClientDeleting" ... /&gt;
&lt;script language="javascript"&gt;
function myOnClientDeleting()
{
args.set_cancel(prompt("Are you sure?"));
}
&lt;/script&gt;

OnClientProgressUpdating

Gets or sets the client progress updating.

[Browsable(true)]
[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("progressUpdating")]
public string OnClientProgressUpdating { get; set; }

Property Value:

The client progress updating.

OnClientValidationFailed

Gets or sets the name of the client-side function which will be executed if the selected file has invalid extension

[Bindable(true)]
[ClientControlEvent]
[ClientPropertyName("validationFailed")]
public string OnClientValidationFailed { get; set; }

Property Value:

The default value is string.Empty.

If specified, the onClientValidationFailed client-side event is called when a file has invalid extension or its size exceeds the maximum allowed size
sender, the async upload client object;
eventArgs with two properties:
get_fileName(), the name of the file that failed to upload.
get_fileInputField(), the file input field DOM element.

This event cannot be cancelled.

Example:

<p>&lt;script type="text/javascript"&gt;<br />
function onClientValidationFailed(sender, eventArgs)<br />
{<br />
       var fileName = eventArgs.get_fileName();<br />
       var input = eventArgs.get_fileInputField();<br />
}<br />
&lt;/script&gt;</p>
<p>&lt;telerik:RadAsyncUpload ID="RadAsyncUpload1"<br />
runat="server"<br />
    <strong>OnClientValidationFailed="onClientValidationFailed"</strong>&gt;<br />
....<br />
&lt;/telerik:RadAsyncUpload&gt;</p>

PersistConfiguration

Gets or sets whether the upload configuration to be persisted into ControlState(if the upload configuration is different than null).

[Browsable(true)]
public bool PersistConfiguration { get; set; }

Property Value:

The default value is false.

PostbackTriggers

Comma separated values - controls' ids. If the property is set the client state is updated in case some of the enumerated controls, triggered a postback.

[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public string[] PostbackTriggers { get; set; }

Property Value:

The default value is string.Empty.

SupportsRenderingMode

protected override bool SupportsRenderingMode { get; }

Overrides: RadWebControl.SupportsRenderingMode

TargetFolder

Gets or sets the virtual path of the folder, where RadUpload will automatically save the valid files after the upload completes.

[Browsable(true)]
[Bindable(true)]
public string TargetFolder { get; set; }

Property Value:

A string containing the virtual path of the folder where RadUpload will automatically save the valid files after the upload completes. The default value is string.Empty.

When set to string.Empty, the files must be saved manually to the desired location.

Sets how long temporary files should be kept before automatically deleting them. The property accepts TimeSpan values. The default value is 4 hours. More information regarding the TimeSpan structure can be found here - http://www.dotnetperls.com/timespan RadAsyncUpload1.TemporaryFileExpiration = New TimeSpan(2, 0, 0, 0, 0);

public TimeSpan TemporaryFileExpiration { get; set; }

Note that when a postback occurs temporary files are either saved as permanent or removed. The expiration time is used only in cases when files are uploaded asynchronously, but a subsequent postback does not occur.

TemporaryFolder

IAsyncUploadConfiguration

Path to a folder where RadAsyncUpload should save files temporarily until a postback occurs.

public string TemporaryFolder { get; set; }

The ASP.NET process needs to have Write permissions for the specified folder. Also note that in Medium Trust scenarios this should point to a subfolder of the Application Path. Defaults to App_Data\RadUploadTemp subfolder of the Application Path.

UploadConfiguration

Sets upload configuration that has additional information. The generic object can be obtained using the CreateUploadConfiguration <T> method, where T is custom class that implements IAsyncUploadConfiguration. The custom class can contain any sort of custom data.

[Browsable(false)]
public IAsyncUploadConfiguration UploadConfiguration { get; set; }

UploadedFiles

UploadedFileCollection

Provides access to the valid files uploaded by the RadAsyncUpload instance.

[Browsable(false)]
public UploadedFileCollection UploadedFiles { get; }

Property Value:

UploadedFileCollection containing all valid files uploaded using a RadAsyncUpload control.

Example:

cs-api-definition
For Each file As Telerik.WebControls.UploadedFile In RadAsyncUpload1.UploadedFiles
file.SaveAs(Path.Combine("c:\my files\", file.GetName()), True)
Next
cs-api-definition.skip-repl
foreach (Telerik.Web.UI.UploadedFile file in RadAsyncUpload1.UploadedFiles)
{
file.SaveAs(Path.Combine(@"c:\my files\", file.GetName()), true);
}

UploadedFilesRendering

Specify where the uploaded files should be positioned, below or above the current file input.

[ClientControlProperty]
[ClientPropertyName("_uploadedFilesRendering")]
public UploadedFilesRendering UploadedFilesRendering { get; set; }

Property Value:

The default value is AboveFileInput

Setting the UploadedFilesRendering property to BelowFileInput means that RadAsyncUpload will render the uploaded files below the current file input. Otherwise the uploaded files will be rendered above the file input.

UploadRequestIdentifier

Gets or sets the upload request identifier.

[Browsable(false)]
[ClientControlProperty]
[ClientPropertyName("_pageGUID")]
public string UploadRequestIdentifier { get; set; }

Property Value:

The upload request identifier.

If the value is IsNullOrEmpty, a NewGuid value is assigned.

UseApplicationPoolImpersonation

Gets or sets whether to use application pool impersonation.

[PersistenceMode(PersistenceMode.Attribute)]
public bool UseApplicationPoolImpersonation { get; set; }

Property Value:

The usage of application pool impersonation.

Methods

AddAttributesToRender(HtmlTextWriter)

protected override void AddAttributesToRender(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadWebControl.AddAttributesToRender(HtmlTextWriter)

CheckFileNameForInvalidChars(string)

protected virtual bool CheckFileNameForInvalidChars(string fileName)

Parameters:fileNamestringReturns:

CheckForHandlerRegistration()

protected virtual void CheckForHandlerRegistration()

CreateDefaultUploadConfiguration<T>()

Creates an object of type T (that implements IAsyncUploadConfiguration) and populates all properties specified in the interface from this RadAsyncUpload instance. The user is then free to populate any additional properties.

public T CreateDefaultUploadConfiguration<T>() where T : IAsyncUploadConfiguration, new()

Returns:

An object of type T populated with all properties specified in IAsyncUploadConfiguration

DescribeComponent(IScriptDescriptor)

protected override void DescribeComponent(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

EnsureDefaultTemporaryFolderExists()

protected virtual void EnsureDefaultTemporaryFolderExists()

GetPostBackTriggerID()

protected virtual string GetPostBackTriggerID()

Returns:

IsClientStatePlayable()

protected virtual bool IsClientStatePlayable()

Returns:

LoadControlState(object)

protected override void LoadControlState(object savedState)

Parameters:savedStateobject

Overrides: Control.LoadControlState(object)

LoadPostData(string, NameValueCollection)

Executed when post data is loaded from the request

protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)

Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

Overrides: RadWebControl.LoadPostData(string, NameValueCollection)

OnFileUploaded(FileUploadedEventArgs)

protected virtual void OnFileUploaded(FileUploadedEventArgs e)

Parameters:eFileUploadedEventArgs

OnInit(EventArgs)

protected override void OnInit(EventArgs e)

Parameters:eEventArgs

Overrides: RadWebControl.OnInit(EventArgs)

OnPreRender(EventArgs)

protected override void OnPreRender(EventArgs e)

Parameters:eEventArgs

Overrides: RadWebControl.OnPreRender(EventArgs)

PlayClientState(string)

protected virtual void PlayClientState(string clientStateValue)

Parameters:clientStateValuestring

RaisePostDataChangedEvent()

Executed when post data changes should invoke a changed event

protected override void RaisePostDataChangedEvent()

Overrides: RadWebControl.RaisePostDataChangedEvent()

RenderContents(HtmlTextWriter)

protected override void RenderContents(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderContents(HtmlTextWriter)

SaveClientState()

Saves the client state data

protected override string SaveClientState()

Returns:

Overrides: RadWebControl.SaveClientState()

SaveControlState()

protected override object SaveControlState()

Returns:

object

Overrides: Control.SaveControlState()

TestTemporaryFolderPermissions()

protected virtual void TestTemporaryFolderPermissions()

ValidateFileExtension(string)

protected virtual bool ValidateFileExtension(string fileExtension)

Parameters:fileExtensionstringReturns: