Bagikan melalui

BackgroundWorker.ReportProgress Metode

  • Referensi

Definisi

Ruang nama:
System.ComponentModel
Rakitan:
System.dll, System.ComponentModel.EventBasedAsync.dll
Rakitan:
System.ComponentModel.EventBasedAsync.dll
Rakitan:
System.dll
Rakitan:
netstandard.dll

Memunculkan kejadian ProgressChanged.

Overload

ReportProgress(Int32)

Memunculkan kejadian ProgressChanged.
ReportProgress(Int32, Object)

Memunculkan kejadian ProgressChanged.

ReportProgress(Int32)

Sumber:
BackgroundWorker.cs
Sumber:
BackgroundWorker.cs
Sumber:
BackgroundWorker.cs

Memunculkan kejadian ProgressChanged.

public:
 void ReportProgress(int percentProgress);
public void ReportProgress (int percentProgress);
member this.ReportProgress : int -> unit
Public Sub ReportProgress (percentProgress As Integer)

Parameter

percentProgress
Int32

Persentase, dari 0 hingga 100, dari operasi latar belakang yang selesai.

Pengecualian

InvalidOperationException

Properti WorkerReportsProgress diatur ke false.

Contoh

Contoh kode berikut menunjukkan penggunaan ReportProgress metode untuk melaporkan kemajuan operasi asinkron kepada pengguna. Contoh kode ini adalah bagian dari contoh yang lebih besar yang disediakan untuk BackgroundWorker kelas .

// Abort the operation if the user has cancelled.
// Note that a call to CancelAsync may have set 
// CancellationPending to true just after the
// last invocation of this method exits, so this 
// code will not have the opportunity to set the 
// DoWorkEventArgs.Cancel flag to true. This means
// that RunWorkerCompletedEventArgs.Cancelled will
// not be set to true in your RunWorkerCompleted
// event handler. This is a race condition.
if ( worker->CancellationPending )
{
   e->Cancel = true;
}
else
{
   if ( n < 2 )
   {
      result = 1;
   }
   else
   {
      result = ComputeFibonacci( n - 1, worker, e ) + ComputeFibonacci( n - 2, worker, e );
   }

   // Report progress as a percentage of the total task.
   int percentComplete = (int)((float)n / (float)numberToCompute * 100);
   if ( percentComplete > highestPercentageReached )
   {
      highestPercentageReached = percentComplete;
      worker->ReportProgress( percentComplete );
   }
}

// Abort the operation if the user has canceled.
// Note that a call to CancelAsync may have set 
// CancellationPending to true just after the
// last invocation of this method exits, so this 
// code will not have the opportunity to set the 
// DoWorkEventArgs.Cancel flag to true. This means
// that RunWorkerCompletedEventArgs.Cancelled will
// not be set to true in your RunWorkerCompleted
// event handler. This is a race condition.

if (worker.CancellationPending)
{   
    e.Cancel = true;
}
else
{   
    if (n < 2)
    {   
        result = 1;
    }
    else
    {   
        result = ComputeFibonacci(n - 1, worker, e) + 
                 ComputeFibonacci(n - 2, worker, e);
    }

    // Report progress as a percentage of the total task.
    int percentComplete = 
        (int)((float)n / (float)numberToCompute * 100);
    if (percentComplete > highestPercentageReached)
    {
        highestPercentageReached = percentComplete;
        worker.ReportProgress(percentComplete);
    }
}

' Abort the operation if the user has canceled.
' Note that a call to CancelAsync may have set 
' CancellationPending to true just after the
' last invocation of this method exits, so this 
' code will not have the opportunity to set the 
' DoWorkEventArgs.Cancel flag to true. This means
' that RunWorkerCompletedEventArgs.Cancelled will
' not be set to true in your RunWorkerCompleted
' event handler. This is a race condition.
If worker.CancellationPending Then
    e.Cancel = True
Else
    If n < 2 Then
        result = 1
    Else
        result = ComputeFibonacci(n - 1, worker, e) + _
                 ComputeFibonacci(n - 2, worker, e)
    End If

    ' Report progress as a percentage of the total task.
    Dim percentComplete As Integer = _
        CSng(n) / CSng(numberToCompute) * 100
    If percentComplete > highestPercentageReached Then
        highestPercentageReached = percentComplete
        worker.ReportProgress(percentComplete)
    End If

End If

Keterangan

Jika Anda memerlukan operasi latar belakang untuk melaporkan kemajuannya, Anda dapat memanggil ReportProgress metode untuk meningkatkan ProgressChanged peristiwa. Nilai WorkerReportsProgress properti harus true, atau ReportProgress akan melempar InvalidOperationException.

Terserah Anda untuk menerapkan cara yang bermakna untuk mengukur kemajuan operasi latar belakang Anda sebagai persentase dari total tugas yang diselesaikan.

Panggilan ke ReportProgress metode ini asinkron dan segera kembali. Penanganan ProgressChanged aktivitas dijalankan pada utas yang membuat BackgroundWorker.

Lihat juga

Berlaku untuk

ReportProgress(Int32, Object)

Sumber:
BackgroundWorker.cs
Sumber:
BackgroundWorker.cs
Sumber:
BackgroundWorker.cs

Memunculkan kejadian ProgressChanged.

public:
 void ReportProgress(int percentProgress, System::Object ^ userState);
public void ReportProgress (int percentProgress, object userState);
public void ReportProgress (int percentProgress, object? userState);
member this.ReportProgress : int * obj -> unit
Public Sub ReportProgress (percentProgress As Integer, userState As Object)

Parameter

percentProgress
Int32

Persentase, dari 0 hingga 100, dari operasi latar belakang yang selesai.

userState
Object

Object Unik yang menunjukkan status pengguna. Dikembalikan sebagai UserState properti dari ProgressChangedEventArgs.

Pengecualian

InvalidOperationException

Properti WorkerReportsProgress diatur ke false.

Contoh

Contoh kode berikut menunjukkan penggunaan ReportProgress metode untuk melaporkan kemajuan operasi asinkron kepada pengguna. Contoh kode ini adalah bagian dari contoh yang lebih besar yang disediakan untuk ToolStripProgressBar kelas .

private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
{
    // This method will run on a thread other than the UI thread.
    // Be sure not to manipulate any Windows Forms controls created
    // on the UI thread from this method.
    backgroundWorker.ReportProgress(0, "Working...");
    Decimal lastlast = 0;
    Decimal last = 1;
    Decimal current;
    if (requestedCount >= 1)
    { AppendNumber(0); }
    if (requestedCount >= 2)
    { AppendNumber(1); }
    for (int i = 2; i < requestedCount; ++i)
    {
        // Calculate the number.
        checked { current = lastlast + last; }
        // Introduce some delay to simulate a more complicated calculation.
        System.Threading.Thread.Sleep(100);
        AppendNumber(current);
        backgroundWorker.ReportProgress((100 * i) / requestedCount, "Working...");
        // Get ready for the next iteration.
        lastlast = last;
        last = current;
    }

    backgroundWorker.ReportProgress(100, "Complete!");
}

Private Sub backgroundWorker1_DoWork(sender As Object, e As DoWorkEventArgs)
   ' This method will run on a thread other than the UI thread.
   ' Be sure not to manipulate any Windows Forms controls created
   ' on the UI thread from this method.
   backgroundWorker.ReportProgress(0, "Working...")
   Dim lastlast As [Decimal] = 0
   Dim last As [Decimal] = 1
   Dim current As [Decimal]
   If requestedCount >= 1 Then
      AppendNumber(0)
   End If
   If requestedCount >= 2 Then
      AppendNumber(1)
   End If
   Dim i As Integer
   
   While i < requestedCount
      ' Calculate the number.
      current = lastlast + last
      ' Introduce some delay to simulate a more complicated calculation.
      System.Threading.Thread.Sleep(100)
      AppendNumber(current)
      backgroundWorker.ReportProgress(100 * i / requestedCount, "Working...")
      ' Get ready for the next iteration.
      lastlast = last
      last = current
      i += 1
   End While
   
   
   backgroundWorker.ReportProgress(100, "Complete!")
 End Sub

Keterangan

Jika Anda memerlukan operasi latar belakang untuk melaporkan kemajuannya, Anda dapat memanggil ReportProgress metode untuk meningkatkan ProgressChanged peristiwa. Nilai WorkerReportsProgress properti harus true, atau ReportProgress akan melempar InvalidOperationException.

Terserah Anda untuk menerapkan cara yang bermakna untuk mengukur kemajuan operasi latar belakang Anda sebagai persentase dari total tugas yang diselesaikan.

Lihat juga

Berlaku untuk