WebClient.OnDownloadFileCompleted Method

Raises the DownloadFileCompleted event.

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

protected virtual void OnDownloadFileCompleted(
	AsyncCompletedEventArgs e
)

Parameters

e
Type: System.ComponentModel.AsyncCompletedEventArgs

An AsyncCompletedEventArgs object containing event data.

Classes that inherit from this class can override this method to perform additional tasks when the DownloadFileCompleted event occurs.

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnDownloadFileCompleted method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding OnDownloadFileCompleted in a derived class, be sure to call the base class’s OnDownloadFileCompleted method so that registered delegates receive the event.

The following code example shows an implementation of this method that can be customized by a class derived from WebClient.

protected   override void OnDownloadFileCompleted (System.ComponentModel.AsyncCompletedEventArgs e)
{
    // Here you can perform any custom actions before the event is raised 
    // and event handlers are called... 

    base.OnDownloadFileCompleted(e);

    // Here you can perform any post event actions...
}

.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

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft