DownloadProgressChangedEventArgs Class

 

Provides data for the DownloadProgressChanged event of a WebClient.

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

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

Public Class DownloadProgressChangedEventArgs
	Inherits ProgressChangedEventArgs

NameDescription
System_CAPS_pubpropertyBytesReceived

Gets the number of bytes received.

System_CAPS_pubpropertyProgressPercentage

Gets the asynchronous task progress percentage.(Inherited from ProgressChangedEventArgs.)

System_CAPS_pubpropertyTotalBytesToReceive

Gets the total number of bytes in a WebClient data download operation.

System_CAPS_pubpropertyUserState

Gets a unique user state.(Inherited from ProgressChangedEventArgs.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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

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

.NET Framework
Available since 2.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

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

Return to top
Show: