Export (0) Print
Expand All

DownloadProgressChangedEventArgs Class

Provides data for the DownloadProgressChanged event of a WebClient.

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

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

'Declaration
Public Class DownloadProgressChangedEventArgs _
	Inherits ProgressChangedEventArgs

The DownloadProgressChangedEventArgs type exposes the following members.

  NameDescription
Public propertyBytesReceivedGets the number of bytes received.
Public propertyProgressPercentageGets the asynchronous task progress percentage. (Inherited from ProgressChangedEventArgs.)
Public propertyTotalBytesToReceiveGets the total number of bytes in a WebClient data download operation.
Public propertyUserStateGets a unique user state. (Inherited from ProgressChangedEventArgs.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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