Export (0) Print
Expand All

WebClient.UploadProgressChanged Event

Note: This event is new in the .NET Framework version 2.0.

Occurs when an asynchronous upload operation successfully transfers some or all of the data.

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

'Declaration
Public Event UploadProgressChanged As UploadProgressChangedEventHandler
'Usage
Dim instance As WebClient
Dim handler As UploadProgressChangedEventHandler

AddHandler instance.UploadProgressChanged, handler

/** @event */
public void add_UploadProgressChanged (UploadProgressChangedEventHandler value)

/** @event */
public void remove_UploadProgressChanged (UploadProgressChangedEventHandler value)

JScript supports the use of events, but not the declaration of new ones.

This event is raised each time an asynchronous upload makes progress. This event is raised when uploads are started using any of the following methods.

Method

Description

UploadDataAsync

Sends a Byte array to the resource, without blocking the calling thread.

UploadFileAsync

Sends a local file to the resource, without blocking the calling thread.

UploadValuesAsync

Sends a NameValueCollection to the resource and returns a Byte array containing any response, without blocking the calling thread.

The UploadProgressChangedEventHandler is the delegate for this event. The UploadProgressChangedEventArgs class provides the event handler with event data.

For more information about handling events, see Consuming Events.

The following code example demonstrates setting an event handler for this event.

'  Sample call: UploadFileInBackground2("http:' www.contoso.com/fileUpload.aspx", "data.txt")
Public Shared Sub UploadFileInBackground2(ByVal address As String, ByVal fileName As String)

    Dim client As WebClient = New WebClient()
                Dim uri as Uri =  New Uri(address)
    AddHandler client.UploadFileCompleted, AddressOf UploadFileCallback2

    '  Specify a progress notification handler.
    AddHandler client.UploadProgressChanged, AddressOf UploadProgressCallback
    client.UploadFileAsync(uri, "POST", fileName)
    Console.WriteLine("File upload started.")
End Sub


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

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
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

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

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft