asp.NetBackgroundWorkerバックグラウンドでファイルをダウンロード

例:
次のコード例では、BackgroundWorkerコンポーネントを使用してURLからXMLファイルをロードする方法を示します.ユーザーが[ダウンロード]ボタンをクリックすると、ClickイベントハンドラはBackgroundWorkerコンポーネントのRunWorkerAsyncメソッドを呼び出してダウンロード操作を開始します.ダウンロード中にボタンが無効になり、ダウンロードが完了したら有効になります.MessageBoxにファイルの内容が表示されます.

 
  
using System; 
  
using System.Collections.Generic; 
  
using System.ComponentModel; 
  
using System.Drawing; 
  
using System.Threading; 
  
using System.Windows.Forms; 
  
using System.Xml; 
  
public class Form1 : Form 
  
{ 
  
private BackgroundWorker backgroundWorker1; 
  
private Button dowloadButton; 
  
private XmlDocument document = null; 
  
public Form1() 
  
{ 
  
InitializeComponent(); 
  
} 
  
private void dowloadButton_Click(object sender, EventArgs e) 
  
{ 
  
// Start the download operation in the background. 
  
this.backgroundWorker1.RunWorkerAsync(); 
  
// Disable the button for the duration of the download. 
  
this.dowloadButton.Enabled = false; 
  
// Wait for the BackgroundWorker to finish the download. 
  
while (this.backgroundWorker1.IsBusy) 
  
{ 
  
// Keep UI messages moving, so the form remains 
  
// responsive during the asynchronous operation. 
  
Application.DoEvents(); 
  
} 
  
// The download is done, so enable the button. 
  
this.dowloadButton.Enabled = true; 
  
} 
  
private void backgroundWorker1_DoWork( 
  
object sender, 
  
DoWorkEventArgs e) 
  
{ 
  
document = new XmlDocument(); 
  
// Replace this file name with a valid file name. 
  
document.Load(@"http://www.tailspintoys.com/sample.xml"); 
  
// Uncomment the following line to 
  
// simulate a noticeable latency. 
  
//Thread.Sleep(5000); 
  
} 
  
private void backgroundWorker1_RunWorkerCompleted( 
  
object sender, 
  
RunWorkerCompletedEventArgs e) 
  
{ 
  
if (e.Error == null) 
  
{ 
  
MessageBox.Show(document.InnerXml, "Download Complete"); 
  
} 
  
else 
  
{ 
  
MessageBox.Show( 
  
"Failed to download file", 
  
"Download failed", 
  
MessageBoxButtons.OK, 
  
MessageBoxIcon.Error ); 
  
} 
  
} 
  
/// 
 
  
/// Required designer variable. 
  
/// 
 
  
private System.ComponentModel.IContainer components = null; 
  
/// 
 
  
/// Clean up any resources being used. 
  
/// 
 
  
/// true if managed resources should be disposed; otherwise, false. 
  
protected override void Dispose(bool disposing) 
  
{ 
  
if (disposing && (components != null)) 
  
{ 
  
components.Dispose(); 
  
} 
  
base.Dispose(disposing); 
  
} 
  
#region Windows Form Designer generated code 
  
/// 
 
  
/// Required method for Designer support - do not modify 
  
/// the contents of this method with the code editor. 
  
/// 
 
  
private void InitializeComponent() 
  
{ 
  
this.backgroundWorker1 = new System.ComponentModel.BackgroundWorker(); 
  
this.dowloadButton = new System.Windows.Forms.Button(); 
  
this.SuspendLayout(); 
  
// 
  
// backgroundWorker1 
  
// 
  
this.backgroundWorker1.DoWork += new System.ComponentModel.DoWorkEventHandler(this.backgroundWorker1_DoWork); 
  
this.backgroundWorker1.RunWorkerCompleted += new System.ComponentModel.RunWorkerCompletedEventHandler(this.backgroundWorker1_RunWorkerCompleted); 
  
// 
  
// dowloadButton 
  
// 
  
this.dowloadButton.Location = new System.Drawing.Point(12, 12); 
  
this.dowloadButton.Name = "dowloadButton"; 
  
this.dowloadButton.Size = new System.Drawing.Size(75, 23); 
  
this.dowloadButton.TabIndex = 0; 
  
this.dowloadButton.Text = "Download file"; 
  
this.dowloadButton.UseVisualStyleBackColor = true; 
  
this.dowloadButton.Click += new System.EventHandler(this.dowloadButton_Click); 
  
// 
  
// Form1 
  
// 
  
this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F); 
  
this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; 
  
this.ClientSize = new System.Drawing.Size(104, 54); 
  
this.Controls.Add(this.dowloadButton); 
  
this.Name = "Form1"; 
  
this.Text = "Form1"; 
  
this.ResumeLayout(false); 
  
} 
  
#endregion 
  
} 
  
static class Program 
  
{ 
  
/// 
 
  
/// The main entry point for the application. 
  
/// 
 
  
[STAThread] 
  
static void Main() 
  
{ 
  
Application.EnableVisualStyles(); 
  
Application.Run(new Form1()); 
  
} 
  
} 
  
 
 

ファイルのダウンロード:
ファイルのダウンロードは、DoWorkイベントハンドラを実行するBackgroundWorkerコンポーネントの補助スレッドで行います.コードがRunWorkerAsyncメソッドを呼び出すと、このスレッドが開始されます.

 
  
private void backgroundWorker1_DoWork( 
  
object sender, 
  
DoWorkEventArgs e) 
  
{ 
  
document = new XmlDocument(); 
  
// Replace this file name with a valid file name. 
  
document.Load(@"http://www.tailspintoys.com/sample.xml"); 
  
// Uncomment the following line to 
  
// simulate a noticeable latency. 
  
//Thread.Sleep(5000); 
  
} 
  
 
 

BackgroundWorkerの完了を待つ
dowloadButton_Clickイベントハンドラは、BackgroundWorkerコンポーネントが非同期タスクを完了するのを待つ方法を示します.IsBusyプロパティを使用して、BackgroundWorkerスレッドがまだ実行されているかどうかを決定します.コードがプライマリUIスレッド上にある場合(Clickイベントハンドラの場合)、必ずApplicationを呼び出す.DoEventsメソッドは、ユーザインタフェースがユーザ操作に応答できるようにする.

 
  
private void dowloadButton_Click(object sender, EventArgs e) 
  
{ 
  
// Start the download operation in the background. 
  
this.backgroundWorker1.RunWorkerAsync(); 
  
// Disable the button for the duration of the download. 
  
this.dowloadButton.Enabled = false; 
  
// Wait for the BackgroundWorker to finish the download. 
  
while (this.backgroundWorker1.IsBusy) 
  
{ 
  
// Keep UI messages moving, so the form remains 
  
// responsive during the asynchronous operation. 
  
Application.DoEvents(); 
  
} 
  
// The download is done, so enable the button. 
  
this.dowloadButton.Enabled = true; 
  
} 
  
 
 

結果を表示
backgroundWorker1_RunWorkerCompletedメソッドは、RunWorkerCompletedイベントを処理し、バックグラウンド操作が完了した後に呼び出されます.まず確認しますErrorプロパティはnullの場合、ファイルの内容を表示します.

 
  
private void backgroundWorker1_RunWorkerCompleted( 
  
object sender, 
  
RunWorkerCompletedEventArgs e) 
  
{ 
  
if (e.Error == null) 
  
{ 
  
MessageBox.Show(document.InnerXml, "Download Complete"); 
  
} 
  
else 
  
{ 
  
MessageBox.Show( 
  
"Failed to download file", 
  
"Download failed", 
  
MessageBoxButtons.OK, 
  
MessageBoxIcon.Error ); 
  
} 
  
}