Export (0) Print
Expand All
Expand Minimize

DownloadStringCompletedEventHandler Delegate

Represents the method that will handle the DownloadStringCompleted event of a WebClient.

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

public delegate void DownloadStringCompletedEventHandler(
	Object sender,
	DownloadStringCompletedEventArgs e
)

Parameters

sender
Type: System.Object

The source of the event.

e
Type: System.Net.DownloadStringCompletedEventArgs

A DownloadStringCompletedEventArgs that contains event data.

When you create a DownloadStringCompletedEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see Events and Delegates.

The following code example demonstrates downloading a string asynchronously.

    // Sample call : DownloadStringInBackground2 ("http://www.contoso.com/GameScores.html");
    public static void DownloadStringInBackground2 (string address)
    {
        WebClient client = new WebClient ();
        Uri uri = new Uri(address);

        // Specify that the DownloadStringCallback2 method gets called 
        // when the download completes.
        client.DownloadStringCompleted += new DownloadStringCompletedEventHandler (DownloadStringCallback2);
        client.DownloadStringAsync (uri);
    }

The following method is called when the download completes.

    private static void DownloadStringCallback2 (Object sender, DownloadStringCompletedEventArgs e)
    {
        // If the request was not canceled and did not throw 
        // an exception, display the resource. 
        if (!e.Cancelled && e.Error == null)
        {
            string textString = (string)e.Result;

            Console.WriteLine (textString);
        }
    }

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, 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.

Show:
© 2014 Microsoft