WebClient.UploadFileCompleted Event (System.Net)

UploadFileCompleted Event

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

WebClient..::.UploadFileCompleted Event

Occurs when an asynchronous file-upload operation completes.

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

Syntax

Visual Basic (Declaration)

Public Event UploadFileCompleted As UploadFileCompletedEventHandler

Visual Basic (Usage)

Dim instance As WebClient
Dim handler As UploadFileCompletedEventHandler

AddHandler instance.UploadFileCompleted, handler

public event UploadFileCompletedEventHandler UploadFileCompleted

Visual C++

public:
 event UploadFileCompletedEventHandler^ UploadFileCompleted {
    void add (UploadFileCompletedEventHandler^ value);
    void remove (UploadFileCompletedEventHandler^ value);
}

JScript

JScript does not support events.

Remarks

This event is raised each time an asynchronous file upload operation completes. Asynchronous file uploads are started by calling the UploadFileAsync methods.

The UploadFileCompletedEventHandler is the delegate for this event. The UploadFileCompletedEventArgs class provides the event handler with event data.

For more information about handling events, see Consuming Events.

Examples

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

Visual Basic

        '  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

    // Sample call: UploadFileInBackground2("http://www.contoso.com/fileUpload.aspx", "data.txt")
    public static void UploadFileInBackground2 (string address, string fileName)
    {
        WebClient client = new WebClient ();
        Uri uri = new Uri(address);

        client.UploadFileCompleted += new UploadFileCompletedEventHandler (UploadFileCallback2);

     // Specify a progress notification handler.
     client.UploadProgressChanged += new UploadProgressChangedEventHandler(UploadProgressCallback);
        client.UploadFileAsync (uri, "POST", fileName);
        Console.WriteLine ("File upload started.");
    }

Visual C++

// Sample call: UploadFileInBackground2("http://www.contoso.com/fileUpload.aspx", "data.txt")
void UploadFileInBackground2( String^ address, String^ fileName )
{
   WebClient^ client = gcnew WebClient;
   Uri ^uri = gcnew Uri(address);

   client->UploadFileCompleted += 
     gcnew UploadFileCompletedEventHandler (UploadFileCallback2);

   // Specify a progress notification handler.
   client->UploadProgressChanged += 
       gcnew UploadProgressChangedEventHandler( UploadProgressCallback );
   client->UploadFileAsync( uri, "POST", fileName );
   Console::WriteLine( "File upload started." );
}

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

WebClient Class

WebClient Members

System.Net Namespace