This documentation is archived and is not being maintained.

DownloadProgressChangedEventArgs Class

Provides data for the DownloadProgressChanged event of a WebClient.

Namespace:  System.Net
Assembly:  System (in System.dll)

'Declaration
Public Class DownloadProgressChangedEventArgs _
	Inherits ProgressChangedEventArgs
'Usage
Dim instance As DownloadProgressChangedEventArgs

Instances of this class are passed to the DownloadProgressChangedEventHandler.

The following code example demonstrates setting an event handler for the DownloadProgressChanged event.

		'  Sample call : DownLoadFileInBackground2 ("http:' www.contoso.com/logs/January.txt") 
		Public Shared Sub DownLoadFileInBackground2(ByVal address As String)

			Dim client As WebClient = New WebClient()

			'  Specify that the DownloadFileCallback method gets called 
			'  when the download completes. 
			AddHandler client.DownloadFileCompleted, AddressOf DownloadFileCallback2
			'  Specify a progress notification handler. 
			AddHandler client.DownloadProgressChanged, AddressOf DownloadProgressCallback
                        Dim uri as Uri = New Uri(address)
			client.DownloadFileAsync(uri, "serverdata.txt")
		End Sub
// Sample call : DownLoadFileInBackground2 ("http://www.contoso.com/logs/January.txt");
void DownLoadFileInBackground2 (String* address)
{
    WebClient* client = new WebClient ();

    // Specify that the DownloadFileCallback method gets called
    // when the download completes.
    client->DownloadFileCompleted += new AsyncCompletedEventHandler (DownloadFileCallback2);
    // Specify a progress notification handler.
    client->DownloadProgressChanged += new DownloadProgressEventHandler(DownloadProgressCallback);
    client->DownloadFileAsync (address, S"serverdata.txt");
}

The following code example shows an implementation of a handler for this event.

Private Shared Sub UploadProgressCallback(ByVal sender As Object, ByVal e As UploadProgressChangedEventArgs)

    '  Displays the operation identifier, and the transfer progress.
    Console.WriteLine("{0}    uploaded {1} of {2} bytes. {3} % complete...", _
     CStr(e.UserState), e.BytesSent, e.TotalBytesToSend, e.ProgressPercentage)
End Sub 
Private Shared Sub DownloadProgressCallback(ByVal sender As Object, ByVal e As DownloadProgressChangedEventArgs)

    '  Displays the operation identifier, and the transfer progress.
    Console.WriteLine("0}    downloaded 1} of 2} bytes. 3} % complete...", _
     CStr(e.UserState), e.BytesReceived, e.TotalBytesToReceive, e.ProgressPercentage)
End Sub
void UploadProgressCallback(Object* /*sender*/, UploadProgressEventArgs* e)
{
    // Displays the operation identifier, and the transfer progress.
    Console::WriteLine(S"{0}    transferred {1} of {2} bytes. {3} % complete...", 
        dynamic_cast<String*>(e->UserToken),
        __box(e->BytesSent),
        __box(e->TotalBytesToSend),
        __box(e->ProgressPercentage));
}
void DownloadProgressCallback(Object* /*sender*/, DownloadProgressEventArgs* e)
{
    // Displays the operation identifier, and the transfer progress.
    Console::WriteLine(S"{0}    transferred {1} of {2} bytes. {3} % complete...", 
        dynamic_cast<String*>(e->UserToken),
        __box(e->BytesReceived),
        __box(e->TotalBytesToReceive),
        __box(e->ProgressPercentage));
}

System.Object
  System.EventArgs
    System.ComponentModel.ProgressChangedEventArgs
      System.Net.DownloadProgressChangedEventArgs

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: