0 out of 3 rated this helpful - Rate this topic

DownloadStringCompletedEventHandler Delegate

.NET Framework 2.0

Other Versions

Note: This delegate is new in the .NET Framework version 2.0.

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

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

Syntax

C++

public delegate void DownloadStringCompletedEventHandler (
	Object sender,
	DownloadStringCompletedEventArgs e
)

/** @delegate */
public delegate void DownloadStringCompletedEventHandler (
	Object sender, 
	DownloadStringCompletedEventArgs e
)

JScript

JScript supports the use of delegates, but not the declaration of new ones.

Parameters

sender: The source of the event.

e: A DownloadStringCompletedEventArgs that contains event data.

Remarks

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.

Example

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.

public 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);
    }
}

Platforms

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0

Reference

System.Net Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD