Click here to Skip to main content
Click here to Skip to main content

Downloading Files in .NET With All Information: Progressbar, Download Speed, Supports Cancel and Resume

, , 22 Apr 2009 CPOL
Rate this:
Please Sign up or sign in to vote.
How to download files in .NET with all information about the progess (progressbar, download speed), supports cancel and resume
Screenshot - screen.jpg

Introduction  

I'll explain how you can build a complete, reliable and powerful download manager with .NET Framework.
It is able to show a rarity of data about the download in progress, including the download speed, the file size, the downloaded size, and the percentage of completion.

A completely new class has been written based on this code, which features logic/layout abstraction, multiple file download support, and is more easy to use by providing a variety of properties and events. Check out the FileDownloader article.

The files are downloaded via the HttpWebRequest  and HttpWebResponse, and written to a file with the StreamWriter. All this is done on a separate thread (with a BackgroundWorker), so the application using this downloader won't freeze.

Using the Code 

The demo application is pretty simple, and contains only the needed UI components for downloading a file. You can of course implement this downloader in your own application, or just use it to download in the background without any user interaction.

The most important code can be found in the DoWork method of the BackgroundWorker. First, an attempt will be made to establish a connection to the file. If this is successful, a script in the Do loop will start downloading the file block by block, until there are no remaining bytes to be downloaded. Note that as soon as a block of data has been received, it's written to the local target file.

Private Sub BackgroundWorker1_DoWork(ByVal sender As System.Object, _
    ByVal e As System.ComponentModel.DoWorkEventArgs) Handles BackgroundWorker1.DoWork

        'Creating the request and getting the response
        Dim theResponse As HttpWebResponse
        Dim theRequest As HttpWebRequest
        Try 'Checks if the file exist

            theRequest = WebRequest.Create(Me.txtFileName.Text)
            theResponse = theRequest.GetResponse
        Catch ex As Exception

            MessageBox.Show("An error occurred while downloading file. _
			Possible causes:" & ControlChars.CrLf & _
                            "1) File doesn't exist" & ControlChars.CrLf & _
                            "2) Remote server error", "Error", _
			MessageBoxButtons.OK, MessageBoxIcon.Error)

            Dim cancelDelegate As New DownloadCompleteSafe(AddressOf DownloadComplete)

            Me.Invoke(cancelDelegate, True)

            Exit Sub
        End Try
        Dim length As Long = theResponse.ContentLength 'Size of the response (in bytes)

        Dim safedelegate As New ChangeTextsSafe(AddressOf ChangeTexts)
        Me.Invoke(safedelegate, length, 0, 0, 0) 'Invoke the TreadsafeDelegate

        Dim writeStream As New IO.FileStream(Me.whereToSave, IO.FileMode.Create)

        'Replacement for Stream.Position (webResponse stream doesn't support seek)
        Dim nRead As Integer

        'To calculate the download speed
        Dim speedtimer As New Stopwatch
        Dim currentspeed As Double = -1
        Dim readings As Integer = 0

        Do

            If BackgroundWorker1.CancellationPending Then 'If user aborts download
                Exit Do
            End If

            speedtimer.Start()

            Dim readBytes(4095) As Byte
            Dim bytesread As Integer = theResponse.GetResponseStream.Read_
						(readBytes, 0, 4096)

            nRead += bytesread
            Dim percent As Short = (nRead * 100) / length

            Me.Invoke(safedelegate, length, nRead, percent, currentspeed)

            If bytesread = 0 Then Exit Do

            writeStream.Write(readBytes, 0, bytesread)

            speedtimer.Stop()

            readings += 1
            If readings >= 5 Then 'For increase precision, _
			' the speed is calculated only every five cycles
                currentspeed = 20480 / (speedtimer.ElapsedMilliseconds / 1000)
                speedtimer.Reset()
                readings = 0
            End If
        Loop

        'Close the streams
        theResponse.GetResponseStream.Close()
        writeStream.Close()

        If Me.BackgroundWorker1.CancellationPending Then

            IO.File.Delete(Me.whereToSave)

            Dim cancelDelegate As New DownloadCompleteSafe(AddressOf DownloadComplete)

            Me.Invoke(cancelDelegate, True)

            Exit Sub

        End If

        Dim completeDelegate As New DownloadCompleteSafe(AddressOf DownloadComplete)

        Me.Invoke(completeDelegate, False)

End Sub

This code uses delegates to invoke methods on the main thread, and pass data about the download progress to them. 

The code does not support FTP downloads, but can be easily modified to do this.  

Resume Downloads 

It is possible to modify the code to allow resuming downloads. Add this code before the first use of the HttpWebRequest object.

theRequest.AddRange(whereYouWantToStart) '<- add this

You'll also need to set the Position property of the FileStream instance to the position where you want to resume the download. So be sure you also save this before the download is cancelled.

Dim writeStream As New IO.FileStream(Me.whereToSave, IO.FileMode.Open)
writeStream.Position = whereYouWantToStart

Calculating Speed 

The code contains built in download speed calculation, using the StopWatch class. This will return another result every time 5 packages have been downloaded. Note that you can also manually calculate the speed, and use a timer to get data at a more regular interval.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Authors

Carmine_XX
Student
Italy Italy
I'm a young Italian student from Milan.
I usually develop in Visual Basic.Net (and also C#), both Windows and Web (ASP.Net) applications.
Moreover I also know some other programming languages: PHP, HTML, SQL, VB6 and Javascript. (and a bit of C++).
All of my programming projects can be found on my website: www.thetotalsite.it.

Jeroen De Dauw
Software Developer
Belgium Belgium
I am a free and open source software enthusiast and freelance software developer with multiple years of experience in both web and desktop development. Currently my primarily focus is on MediaWiki and Semantic MediaWiki work. I'm in the all time top 10 MediaWiki comitters and am one of the WikiWorks consultants. You can contact me at jeroendedauw at gmail for development jobs and questions related to my work.
 
More info can be found on my website [0] and my blog [1]. You can also follow me on twitter [2] and identi.ca [3].
 
[0] http://www.jeroendedauw.com/
[1] http://blog.bn2vs.com/
[2] https://twitter.com/#!/JeroenDeDauw
[3] http://identi.ca/jeroendedauw
Follow on   Twitter

Comments and Discussions

 
GeneralA review of the code... PinmemberTarek Ziani21-Mar-14 5:03 
GeneralMy vote of 5 PinmemberMember 1047116124-Dec-13 4:38 
QuestionActual Download Speed PinmemberGregor Vladoskiv26-Nov-13 3:21 
GeneralMy vote of 5 PinmemberViper20109-Sep-13 15:27 
QuestionHandle Redirects PinmemberMember 1023067425-Aug-13 3:23 
GeneralNo Problem with me, just need PAUSE FEATURE :( Pinmembersayib25-Jul-13 7:51 
GeneralMy vote of 4 Pinmembersayib25-Jul-13 7:46 
QuestionProblem with Downloading Files in .NET With All Information: Progressbar, Download Speed, Supports Cancel and Resume PinmemberMarshallR24-Feb-13 23:19 
AnswerRe: Problem with Downloading Files in .NET With All Information: Progressbar, Download Speed, Supports Cancel and Resume PinmemberCarmine_XX26-Feb-13 1:54 
GeneralRe: Problem with Downloading Files in .NET With All Information: Progressbar, Download Speed, Supports Cancel and Resume PinmemberMember 1077775728-Apr-14 0:54 
QuestionThis demo cann't download large files with size >30MB PinmemberMember 466294231-Jan-13 22:15 
GeneralMy vote of 2 Pinmemberstingrayweb28-May-12 17:14 
GeneralMy vote of 5 PinmemberBeeWayDev14-Feb-12 4:49 
QuestionArithmetic operation resulted in an overflow. Pinmembermusabiralo15-Dec-11 15:30 
AnswerRe: Arithmetic operation resulted in an overflow. PinmemberJeroen De Dauw15-Dec-11 15:47 
Questionproblem with download Pinmemberpjsurve9-May-11 23:17 
RantDownload a File with Progress Change VB.NET PinmemberJustin Spafford8-Jan-11 10:56 
GeneralIt not automatic get file name and file type PinmemberSting258200030-Dec-10 17:21 
GeneralMy vote of 5 PinmemberMadhu Sasi Nair28-Oct-10 23:44 
GeneralMy vote of 1 Pinmembersmartsabbas5217-Aug-10 3:09 
GeneralProblem with download progress PinmemberPassion_Knight7-Jul-10 5:19 
GeneralRe: Problem with download progress Pinmemberjeroen de dauw7-Jul-10 5:21 
GeneralRe: Problem with download progress PinmemberPassion_Knight7-Jul-10 5:22 
GeneralRe: Problem with download progress PinmemberPassion_Knight7-Jul-10 5:27 
GeneralRe: Problem with download progress Pinmemberjeroen de dauw7-Jul-10 5:33 
GeneralRe: Problem with download progress PinmemberPassion_Knight7-Jul-10 5:34 
GeneralRe: Problem with download progress Pinmemberjeroen de dauw7-Jul-10 5:46 
GeneralRe: Problem with download progress PinmemberPassion_Knight7-Jul-10 6:06 
GeneralRe: Problem with download progress PinmemberLancer240423-Aug-10 1:54 
Generalneed a final documentation for this Pinmemberprudhvi1234516-Mar-10 9:57 
GeneralRe: need a final documentation for this Pinmemberjeroen de dauw16-Mar-10 13:11 
GeneralRe: need a final documentation for this PinmemberiJam_j6-Feb-11 19:46 
GeneralProblem in re-calling Me.BackgroundWorker1.RunWorkerAsync() PinmemberDemantorr14-Jan-10 9:29 
GeneralRe: Problem in re-calling Me.BackgroundWorker1.RunWorkerAsync() Pinmemberjeroen de dauw14-Jan-10 11:08 
GeneralMediafire PinmemberJohn Boshelle24-Nov-09 7:24 
QuestionI get the following bug if i use your code Pinmemberghvnd30-Jul-09 23:42 
AnswerRe: I get the following bug if i use your code Pinmemberbn2vs31-Jul-09 8:54 
GeneralPermission to use this code Pinmemberbn2vs18-Apr-09 2:19 
GeneralRe: Permission to use this code PinmemberCarmine_XX18-Apr-09 3:58 
GeneralRe: Permission to use this code Pinmemberbn2vs19-Apr-09 4:47 
GeneralRe: Permission to use this code PinmemberCarmine_XX20-Apr-09 3:02 
GeneralRe: Permission to use this code Pinmemberbn2vs21-Apr-09 2:46 
GeneralRe: Permission to use this code PinmemberCarmine_XX21-Apr-09 3:38 
GeneralRe: Permission to use this code Pinmemberbn2vs21-Apr-09 4:12 
GeneralRe: Permission to use this code Pinmemberbn2vs22-Apr-09 7:03 
GeneralRe: Permission to use this code PinmemberCarmine_XX22-Apr-09 7:26 
GeneralRe: Permission to use this code Pinmemberbn2vs23-Apr-09 3:08 
GeneralRe: Permission to use this code PinmemberCarmine_XX23-Apr-09 3:31 
Generalhaving trouble downloading files that are 1.5gb's or greater PinmemberLoRd_SnOw5-Mar-09 23:15 
GeneralRe: having trouble downloading files that are 1.5gb's or greater Pinmemberdriven6421-Apr-09 18:22 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.1411019.1 | Last Updated 23 Apr 2009
Article Copyright 2007 by Carmine_XX, Jeroen De Dauw
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid