WebClient.UploadProgressChanged イベント

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

WebClient.UploadProgressChanged イベント

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

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

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

Visual Basic (宣言)

Public Event UploadProgressChanged As
 UploadProgressChangedEventHandler

Visual Basic (使用法)

Dim instance As WebClient
Dim handler As UploadProgressChangedEventHandler

AddHandler instance.UploadProgressChanged, handler

C#

public event UploadProgressChangedEventHandler UploadProgressChanged

C++

public:
event UploadProgressChangedEventHandler^ UploadProgressChanged {
    void add (UploadProgressChangedEventHandler^ value);
    void remove (UploadProgressChangedEventHandler^ value);
}

J#

/** @event */
public void add_UploadProgressChanged (UploadProgressChangedEventHandler
 value)

/** @event */
public void remove_UploadProgressChanged (UploadProgressChangedEventHandler
 value)

JScript

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

解説

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

メソッド	説明
UploadDataAsync	呼び出し元のスレッドをブロックせずに、リソースに Byte 配列を送信します。
UploadFileAsync	呼び出し元のスレッドをブロックせずに、リソースにローカル ファイルを送信します。
UploadValuesAsync	呼び出し元のスレッドをブロックせずに、リソースに NameValueCollection を送信し、任意の応答を含む Byte 配列を返します。

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

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

使用例

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

Visual Basic

'  Sample call: UploadFileInBackground2("http:' www.contoso.com/fileUpload.aspx",
 "data.txt")
Public Shared Sub UploadFileInBackground2(ByVal
 address As String, ByVal
 fileName As String)

    Dim client As WebClient = New
 WebClient()
                Dim uri as Uri =  New
 Uri(address)
    AddHandler client.UploadFileCompleted, AddressOf
 UploadFileCallback2

    '  Specify a progress notification handler.
    AddHandler client.UploadProgressChanged, AddressOf
 UploadProgressCallback
    client.UploadFileAsync(uri, "POST", fileName)
    Console.WriteLine("File upload started.")
End Sub

C#

// Sample call: UploadFileInBackground2("http://www.contoso.com/fileUpload.aspx",
 "data.txt")
public static void UploadFileInBackground2
 (string address, string fileName)
{
    WebClient client = new WebClient ();
    Uri uri = new Uri(address);

    client.UploadFileCompleted += new UploadFileCompletedEventHandler
 (UploadFileCallback2);

 // Specify a progress notification handler.
 client.UploadProgressChanged += new UploadProgressChangedEventHandler(UploadProgressCallback);
    client.UploadFileAsync (uri, "POST", fileName);
    Console.WriteLine ("File upload started.");
}

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

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 名前空間