BackgroundWorker.OnProgressChanged メソッド

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

BackgroundWorker.OnProgressChanged メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

ProgressChanged イベントを発生させます。

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

Visual Basic (宣言)

Protected Overridable Sub
 OnProgressChanged ( _
    e As ProgressChangedEventArgs _
)

Visual Basic (使用法)

Dim e As ProgressChangedEventArgs

Me.OnProgressChanged(e)

C#

protected virtual void OnProgressChanged (
    ProgressChangedEventArgs e
)

C++

protected:
virtual void OnProgressChanged (
    ProgressChangedEventArgs^ e
)

J#

protected void OnProgressChanged (
    ProgressChangedEventArgs e
)

JScript

protected function OnProgressChanged (
    e : ProgressChangedEventArgs
)

パラメータ

e

イベント データを格納している EventArgs。

解説

イベントが発生すると、デリゲートを使用してイベント ハンドラが呼び出されます。詳細については、「イベントの発生」を参照してください。

OnProgressChanged メソッドを使用すると、デリゲートを結び付けずに、派生クラスでイベントを処理することもできます。派生クラスでイベントを処理する場合は、この手法をお勧めします。

継承時の注意 派生クラスで OnProgressChanged をオーバーライドする場合は、登録されているデリゲートがイベントを受け取ることができるように、基本クラスの OnProgressChanged メソッドを呼び出してください。

使用例

OnProgressChanged メソッドを使用して、非同期操作の進行状況を報告するコード例を次に示します。このコード例は、AsyncOperationManager クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

' This method is invoked via the AsyncOperation object,
' so it is guaranteed to be executed on the correct thread.
Private Sub CalculateCompleted(ByVal
 operationState As Object)
    Dim e As CalculatePrimeCompletedEventArgs
 = operationState

    OnCalculatePrimeCompleted(e)

End Sub


' This method is invoked via the AsyncOperation object,
' so it is guaranteed to be executed on the correct thread.
Private Sub ReportProgress(ByVal
 state As Object)
    Dim e As ProgressChangedEventArgs = state

    OnProgressChanged(e)

End Sub

Protected Sub OnCalculatePrimeCompleted( _
    ByVal e As CalculatePrimeCompletedEventArgs)

    RaiseEvent CalculatePrimeCompleted(Me,
 e)

End Sub


Protected Sub OnProgressChanged( _
    ByVal e As ProgressChangedEventArgs)

    RaiseEvent ProgressChanged(e)

End Sub

C#

// This method is invoked via the AsyncOperation object,
// so it is guaranteed to be executed on the correct thread.
private void CalculateCompleted(object operationState)
{
    CalculatePrimeCompletedEventArgs e =
        operationState as CalculatePrimeCompletedEventArgs;

    OnCalculatePrimeCompleted(e);
}

// This method is invoked via the AsyncOperation object,
// so it is guaranteed to be executed on the correct thread.
private void ReportProgress(object state)
{
    ProgressChangedEventArgs e =
        state as ProgressChangedEventArgs;

    OnProgressChanged(e);
}

protected void OnCalculatePrimeCompleted(
    CalculatePrimeCompletedEventArgs e)
{
    if (CalculatePrimeCompleted != null)
    {
        CalculatePrimeCompleted(this, e);
    }
}

protected void OnProgressChanged(ProgressChangedEventArgs
 e)
{
    if (ProgressChanged != null)
    {
        ProgressChanged(e);
    }
}

J#

// You are guaranteed to be on the correct thread, as
// this method is invoked via the AsyncOperation object.
private void CalculateCompleted(Object operationState)
{
    CalculatePrimeCompletedEventArgs e = 
        (CalculatePrimeCompletedEventArgs)operationState;
    OnCalculatePrimeCompleted(e);
} //CalculateCompleted

// You are guaranteed to be on the correct thread, as
// this method is invoked via the AsyncOperation object.
private void ReportProgress(Object state)
{
    ProgressChangedEventArgs e = (ProgressChangedEventArgs)state;
    OnProgressChanged(e);
} //ReportProgress

protected void OnCalculatePrimeCompleted(CalculatePrimeCompletedEventArgs
 e)
{
    if (calculatePrimeCompleted != null) {
        calculatePrimeCompleted.Invoke(this, e);
    }
} //OnCalculatePrimeCompleted

protected void OnProgressChanged(ProgressChangedEventArgs
 e)
{
    if (progressChanged != null) {
        progressChanged.Invoke(e);
    }
} //OnProgressChanged

J#

// You are guaranteed to be on the correct thread, as
// this method is invoked via the AsyncOperation object.
private void CalculateCompleted(Object operationState)
{
    CalculatePrimeCompletedEventArgs e = 
        (CalculatePrimeCompletedEventArgs)operationState;
    OnCalculatePrimeCompleted(e);
} //CalculateCompleted

// You are guaranteed to be on the correct thread, as
// this method is invoked via the AsyncOperation object.
private void ReportProgress(Object state)
{
    ProgressChangedEventArgs e = (ProgressChangedEventArgs)state;
    OnProgressChanged(e);
} //ReportProgress

protected void OnCalculatePrimeCompleted(CalculatePrimeCompletedEventArgs
 e)
{
    if (calculatePrimeCompleted != null) {
        calculatePrimeCompleted.Invoke(this, e);
    }
} //OnCalculatePrimeCompleted

protected void OnProgressChanged(ProgressChangedEventArgs
 e)
{
    if (progressChanged != null) {
        progressChanged.Invoke(e);
    }
} //OnProgressChanged

プラットフォーム

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

参照

関連項目
BackgroundWorker クラス
BackgroundWorker メンバ
System.ComponentModel 名前空間
ProgressChanged
その他の技術情報
方法 : バックグラウンドで操作を実行する
方法 : バックグラウンドでファイルをダウンロードする