WebClient.DownloadProgressChanged Событие

Определение

Пространство имен:

System.Net

Сборка:

System.Net.WebClient.dll

Исходный код:

WebClient.cs

Происходит, когда асинхронная операция скачивания успешно передает некоторые или все данные.

public:
 event System::Net::DownloadProgressChangedEventHandler ^ DownloadProgressChanged;

public event System.Net.DownloadProgressChangedEventHandler? DownloadProgressChanged;

member this.DownloadProgressChanged : System.Net.DownloadProgressChangedEventHandler 

Public Custom Event DownloadProgressChanged As DownloadProgressChangedEventHandler 

Тип события

DownloadProgressChangedEventHandler

Примеры

В следующем примере кода показано задание обработчика событий для события DownloadProgressChanged.

// Sample call : DownLoadFileInBackground4 ("http://www.contoso.com/logs/January.txt");
void DownLoadFileInBackground4( String^ address )
{
   WebClient^ client = gcnew WebClient;
   Uri ^uri = gcnew Uri(address);

   // Specify a DownloadFileCompleted handler here...

   // Specify a progress notification handler.
   client->DownloadProgressChanged += gcnew DownloadProgressChangedEventHandler( DownloadProgressCallback4 );
   
   client->DownloadFileAsync( uri, "serverdata.txt" );
}

static void DownloadProgressCallback4(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);
}

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

    // Specify a DownloadFileCompleted handler here...

    // Specify a progress notification handler.
    client.DownloadProgressChanged += new DownloadProgressChangedEventHandler(DownloadProgressCallback4);

    client.DownloadFileAsync(uri, "serverdata.txt");
}

private static void DownloadProgressCallback4(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);
}

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

    Dim client As WebClient = New WebClient()

    ' Specify a DownloadFileCompleted handler here...

    '  Specify a progress notification handler.
    AddHandler client.DownloadProgressChanged, AddressOf DownloadProgressCallback4

    Dim uri as Uri = New Uri(address)
    client.DownloadFileAsync(uri, "serverdata.txt")

End Sub

Private Shared Sub DownloadProgressCallback4(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

Комментарии

Осторожность

WebRequest, HttpWebRequest, ServicePointи WebClient устарели, и их не следует использовать для новой разработки. Вместо этого используйте HttpClient.

Это событие возникает каждый раз, когда асинхронная загрузка выполняется. Это событие возникает при запуске загрузки с помощью любого из следующих методов.

Метод	Описание
DownloadDataAsync	Загружает данные из ресурса и возвращает массив Byte, не блокируя вызывающий поток.
DownloadFileAsync	Загружает данные из ресурса в локальный файл, не блокируя вызывающий поток.
OpenReadAsync	Возвращает данные из ресурса, не блокируя вызывающий поток.

DownloadProgressChangedEventHandler является делегатом для этого события. Класс DownloadProgressChangedEventArgs предоставляет обработчик событий данными о событиях.

Дополнительные сведения об обработке событий см. в обработке и вызове событий.

Заметка

Пассивный передачи FTP-файлов всегда будет отображать процент хода выполнения в нуле, так как сервер не отправил размер файла. Чтобы показать ход выполнения, можно изменить ftp-подключение на активное, переопределив виртуальный метод GetWebRequest(Uri):

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