File Uploader in ASP.NET and ASP.NET MVC

• Download Uploader class - 4.61 KB
• Download Uploader sample in ASP.NET - 8.14 KB
• Download Uploader sample in ASP.NET MVC - 177.93 KB

Introduction

Uploading files is a common scenario and an essential part of many web applications. Here I have created a class which can be used to upload files easily. The uploader class automatically validates all the necessities i.e. validation of upload directory, file extensions, etc.

Background

There are plenty of resources on uploading a file in ASP.NET. But I have felt the need to have a class which would be easier and customizable as well as perform validation, add prefix and/or suffix to file, encrypt filename, allow choice to overwrite existing file or not and so on. You have to just set the necessary properties you need. You can use it in your ASP.NET as well as ASP.NET MVC applications.

Using this Class

Here I am give an example to use this class:

Uploader uploader = new Uploader();

uploader.UploadPath     = Server.MapPath("~\\Content\\Uploads");
uploader.IsLowerName    = true;
uploader.IsEncryptName  = false;

uploader.Prefix = "Hello_";
uploader.Suffix = "_Boom";

uploader.AllowedExtensions.Add(".jpg");
uploader.AllowedExtensions.Add(".jpeg");
uploader.AllowedExtensions.Add(".gif");
uploader.AllowedExtensions.Add(".png");

bool success = uploader.DoUpload("MyFile");

if (success)
{
    //TODO: Code to handle success
}
else
{
    //TODO: Code to handle failure
}

Here MyFile is the name of file input type.

 <!-- In Html -->
<input type="file" name="MyFile" id="MyFile" />

<%--In tradition ASP.NET --%>
<asp:FileUpload ID="MyFile" runat="server" />

There is an overload of DoUpload() method. You can either pass the name of the file input as shown above or HttpPostedFile file object as follows:

HttpPostedFile postedFile =
	HttpContext.Current.Request.Files["MyFile"] as HttpPostedFile;
uploader.DoUpload(postedFile);

There is also a method by which you can get the HttpPostedFile object by supplying the name of the file input.

HttpPostedFile postedFile = uploader.GetHttpPostedFile("MyFile");
uploader.DoUpload(postedFile);

Configuration Settings

If your upload is not successful, then you can get the error code and message with the UploadError property. For example:

string erroCode    = uploader.UploadError.Code;
string errorMessage = uploader.UploadError.Message;

Remember, here the error code is not the actual HTTP error number. I have used numbers from 1 to 10 so that corresponding message can be customized.

On the other hand, if your upload attempt is successful, then you can use information related to the posted file as well as uploaded file by PostedFile and UploadedFile. For example:

string previousFilename = uploader.PostedFile.FileName;
string previousFilePath = uploader.PostedFile.FilePath;

string uploadedFilename = uploader.UploadedFile.FileName;
string uploadedFilePath = uploader.UploadedFile.FilePath;

Enjoy this!

Conclusion

You can see it in my blog.

History

• 23^rd January, 2009: Initial version