WebClient.DownloadProgressChanged イベント

.NET Framework クラス ライブラリ リファレンス

WebClient.DownloadProgressChanged イベント

メモ : このイベントは、.NET Framework version 2.0 で新しく追加されたものです。

非同期ダウンロード操作で、データの一部またはすべてが正常に転送された場合に発生します。

名前空間: System.Net
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Event DownloadProgressChanged As
 DownloadProgressChangedEventHandler

Visual Basic (使用法)

Dim instance As WebClient
Dim handler As DownloadProgressChangedEventHandler

AddHandler instance.DownloadProgressChanged, handler

C#

public event DownloadProgressChangedEventHandler DownloadProgressChanged

C++

public:
event DownloadProgressChangedEventHandler^ DownloadProgressChanged {
    void add (DownloadProgressChangedEventHandler^ value);
    void remove (DownloadProgressChangedEventHandler^ value);
}

J#

/** @event */
public void add_DownloadProgressChanged (DownloadProgressChangedEventHandler
 value)

/** @event */
public void remove_DownloadProgressChanged
 (DownloadProgressChangedEventHandler value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

このイベントは、非同期ダウンロードが進行するたびに発生します。このイベントは、次のメソッドのいずれかを使用してダウンロードが開始されたときに発生します。

メソッド	説明
DownloadDataAsync	呼び出し元のスレッドをブロックせずに、リソースからデータをダウンロードし、Byte 配列を返します。
DownloadFileAsync	呼び出し元のスレッドをブロックせずに、リソースからローカル ファイルにデータをダウンロードします。
OpenReadAsync	呼び出し元のスレッドをブロックせずに、リソースからデータを返します。

DownloadProgressChangedEventHandler は、このイベントのデリゲートです。DownloadProgressChangedEventArgs クラスは、イベント ハンドラにイベント データを提供します。

イベント処理の詳細については、「イベントの利用」を参照してください。

メモ
パッシブ FTP ファイル転送では、サーバーがファイル サイズを送信しないため、進行状況は常に 0 と表示されます。進行状況を表示するには、GetWebRequest 仮想メソッドをオーバーライドして、FTP 接続をアクティブに変更します。

internal class MyWebClient:WebClient{
        protected override WebRequest GetWebRequest(Uri address) {
            FtpWebRequest req = (FtpWebRequest)base.GetWebRequest(address);
            req.UsePassive = false;
            return req;
        }
    }

使用例

このイベントのイベント ハンドラを設定するコード例を次に示します。

Visual Basic

'  Sample call : DownLoadFileInBackground2 ("http:' www.contoso.com/logs/January.txt")
Public Shared Sub DownLoadFileInBackground2(ByVal
 address As String)

    Dim client As WebClient = New
 WebClient()

    '  Specify that the DownloadFileCallback method gets called
    '  when the download completes.
    AddHandler client.DownloadFileCompleted, AddressOf
 DownloadFileCallback2
    '  Specify a progress notification handler.
    AddHandler client.DownloadProgressChanged, AddressOf
 DownloadProgressCallback
                Dim uri as Uri = New
 Uri(address)
    client.DownloadFileAsync(uri, "serverdata.txt")
End Sub

C#

// Sample call : DownLoadFileInBackground2 ("http://www.contoso.com/logs/January.txt");
public static void DownLoadFileInBackground2
 (string address)
{
    WebClient client = new WebClient ();
    Uri uri = new Uri(address);

    // Specify that the DownloadFileCallback method gets called
    // when the download completes.
    client.DownloadFileCompleted += new AsyncCompletedEventHandler
 (DownloadFileCallback2);
    // Specify a progress notification handler.
    client.DownloadProgressChanged += new DownloadProgressChangedEventHandler(DownloadProgressCallback);
    client.DownloadFileAsync (uri, "serverdata.txt");
}

このイベントのハンドラの実装を次のコード例に示します。

Visual Basic

Shared Sub UploadProgressCallback(ByVal
 sender As Object, ByVal
 e As UploadProgressChangedEventArgs)

    '  Displays the operation identifier, and the transfer progress.
    Console.WriteLine("{0}    uploaded {1} of {2} bytes. {3} %
 complete...", _
     CStr(e.UserState), e.BytesSent, e.TotalBytesToSend, e.ProgressPercentage)
End Sub
Shared Sub DownloadProgressCallback(ByVal
 sender As Object, ByVal
 e As DownloadProgressChangedEventArgs)

    '  Displays the operation identifier, and the transfer progress.
    Console.WriteLine("0}    downloaded 1} of 2} bytes. 3} % complete...",
 _
     CStr(e.UserState), e.BytesReceived, e.TotalBytesToReceive, e.ProgressPercentage)
End Sub

C#

static void UploadProgressCallback(object sender,
 UploadProgressChangedEventArgs e)
{
    // Displays the operation identifier, and the transfer progress.
    Console.WriteLine("{0}    uploaded {1} of {2} bytes. {3} % complete...",
 
        (string)e.UserState, 
        e.BytesSent, 
        e.TotalBytesToSend,
        e.ProgressPercentage);
}
static void DownloadProgressCallback(object
 sender, DownloadProgressChangedEventArgs e)
{
    // Displays the operation identifier, and the transfer progress.
    Console.WriteLine("{0}    downloaded {1} of {2} bytes. {3} % complete...",
 
        (string)e.UserState, 
        e.BytesReceived, 
        e.TotalBytesToReceive,
        e.ProgressPercentage);
}

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebClient クラス
WebClient メンバ
System.Net 名前空間