WebClient.OnDownloadStringCompleted(DownloadStringCompletedEventArgs) Method

Definition

Namespace:

System.Net

Assembly:

System.Net.WebClient.dll

Source:

WebClient.cs

Raises the DownloadStringCompleted event.

protected:
 virtual void OnDownloadStringCompleted(System::Net::DownloadStringCompletedEventArgs ^ e);

protected virtual void OnDownloadStringCompleted (System.Net.DownloadStringCompletedEventArgs e);

abstract member OnDownloadStringCompleted : System.Net.DownloadStringCompletedEventArgs -> unit
override this.OnDownloadStringCompleted : System.Net.DownloadStringCompletedEventArgs -> unit

Protected Overridable Sub OnDownloadStringCompleted (e As DownloadStringCompletedEventArgs)

Parameters

e

DownloadStringCompletedEventArgs

A DownloadStringCompletedEventArgs 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 OnDownloadStringCompleted( DownloadStringCompletedEventArgs ^ e ) override
{
   // Here you can perform any custom actions before the event is raised
   // and event handlers are called...
   WebClient::OnDownloadStringCompleted( e );

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

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

    base.OnDownloadStringCompleted (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 DownloadStringCompleted event occurs.

Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

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