WebClient.OnDownloadFileCompleted(AsyncCompletedEventArgs) Method

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.WebClient.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: WebClient.cs

Source:: WebClient.cs

Source:: WebClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Raises the DownloadFileCompleted event.

protected:
 virtual void OnDownloadFileCompleted(System::ComponentModel::AsyncCompletedEventArgs ^ e);

protected virtual void OnDownloadFileCompleted (System.ComponentModel.AsyncCompletedEventArgs e);

abstract member OnDownloadFileCompleted : System.ComponentModel.AsyncCompletedEventArgs -> unit
override this.OnDownloadFileCompleted : System.ComponentModel.AsyncCompletedEventArgs -> unit

Protected Overridable Sub OnDownloadFileCompleted (e As AsyncCompletedEventArgs)

Parameters

e: AsyncCompletedEventArgs

An AsyncCompletedEventArgs object containing event data.

Examples

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

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

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

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

Remarks

Caution

WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete, and you shouldn't use them for new development. Use HttpClient instead.

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 Handling and Raising Events.

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(AsyncCompletedEventArgs) in a derived class, be sure to call the base class' OnDownloadFileCompleted(AsyncCompletedEventArgs) method so that registered delegates receive the event.

Applies to

Share via