RunWorkerCompletedEventArgs Sınıf

Tanım

Ad Alanı:

System.ComponentModel

Bütünleştirilmiş Kod:

System.ComponentModel.EventBasedAsync.dll

Kaynak:

RunWorkerCompletedEvent.cs

MethodNameCompleted olayı için veri sağlar.

public ref class RunWorkerCompletedEventArgs : System::ComponentModel::AsyncCompletedEventArgs

public class RunWorkerCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs

type RunWorkerCompletedEventArgs = class
    inherit AsyncCompletedEventArgs

Public Class RunWorkerCompletedEventArgs
Inherits AsyncCompletedEventArgs

Devralma

Object

EventArgs

AsyncCompletedEventArgs

RunWorkerCompletedEventArgs

Örnekler

Aşağıdaki kod örneğinde kullanımı gösterilmektedir RunWorkerCompletedEventArgs. Bu örnek, sınıfı için BackgroundWorker daha büyük bir örneğin parçasıdır.

// This event handler deals with the results of the
// background operation.
void backgroundWorker1_RunWorkerCompleted( Object^ /*sender*/, RunWorkerCompletedEventArgs^ e )
{
   // First, handle the case where an exception was thrown.
   if ( e->Error != nullptr )
   {
      MessageBox::Show( e->Error->Message );
   }
   else
   if ( e->Cancelled )
   {
      // Next, handle the case where the user cancelled 
      // the operation.
      // Note that due to a race condition in 
      // the DoWork event handler, the Cancelled
      // flag may not have been set, even though
      // CancelAsync was called.
      resultLabel->Text = "Cancelled";
   }
   else
   {
      // Finally, handle the case where the operation 
      // succeeded.
      resultLabel->Text = e->Result->ToString();
   }

   // Enable the UpDown control.
   this->numericUpDown1->Enabled = true;

   // Enable the Start button.
   startAsyncButton->Enabled = true;

   // Disable the Cancel button.
   cancelAsyncButton->Enabled = false;
}

// This event handler deals with the results of the
// background operation.
private void backgroundWorker1_RunWorkerCompleted(
    object sender, RunWorkerCompletedEventArgs e)
{
    // First, handle the case where an exception was thrown.
    if (e.Error != null)
    {
        MessageBox.Show(e.Error.Message);
    }
    else if (e.Cancelled)
    {
        // Next, handle the case where the user canceled 
        // the operation.
        // Note that due to a race condition in 
        // the DoWork event handler, the Cancelled
        // flag may not have been set, even though
        // CancelAsync was called.
        resultLabel.Text = "Canceled";
    }
    else
    {
        // Finally, handle the case where the operation 
        // succeeded.
        resultLabel.Text = e.Result.ToString();
    }

    // Enable the UpDown control.
    this.numericUpDown1.Enabled = true;

    // Enable the Start button.
    startAsyncButton.Enabled = true;

    // Disable the Cancel button.
    cancelAsyncButton.Enabled = false;
}

' This event handler deals with the results of the
' background operation.
Private Sub backgroundWorker1_RunWorkerCompleted( _
ByVal sender As Object, ByVal e As RunWorkerCompletedEventArgs) _
Handles backgroundWorker1.RunWorkerCompleted

    ' First, handle the case where an exception was thrown.
    If (e.Error IsNot Nothing) Then
        MessageBox.Show(e.Error.Message)
    ElseIf e.Cancelled Then
        ' Next, handle the case where the user canceled the 
        ' operation.
        ' Note that due to a race condition in 
        ' the DoWork event handler, the Cancelled
        ' flag may not have been set, even though
        ' CancelAsync was called.
        resultLabel.Text = "Canceled"
    Else
        ' Finally, handle the case where the operation succeeded.
        resultLabel.Text = e.Result.ToString()
    End If

    ' Enable the UpDown control.
    Me.numericUpDown1.Enabled = True

    ' Enable the Start button.
    startAsyncButton.Enabled = True

    ' Disable the Cancel button.
    cancelAsyncButton.Enabled = False
End Sub

Açıklamalar

Zaman uyumsuz işlemler için olay tabanlı zaman uyumsuz desen kullanılırken, Windows Forms formu veya denetimi yöntemini çağırarak BackgroundWorker.RunWorkerAsync zaman uyumsuz bir işlem başlatır. Yöntemi de olayı zaman uyumsuz olarak yükseltir BackgroundWorker.DoWork ve bir DoWorkEventArgs örnek iletir. Zaman uyumsuz işlem bir değer döndürürse, BackgroundWorker.DoWork olay işleyicisi genellikle bunu özelliğine DoWorkEventArgs.Result atar. Zaman uyumsuz işlem tamamlandığında, BackgroundWorker.RunWorkerCompleted olay oluşturulur ve işlemin durumu hakkında bilgi içeren bir RunWorkerCompletedEventArgs örnek geçirilir (iptal edilmiş, hatalı veya başarıyla tamamlanmıştır). Başarıyla tamamlanırsa, Result özelliği zaman uyumsuz işlem tarafından döndürülen ve daha önce özelliğine DoWorkEventArgs.Result atanan değeri içerir.

Not

HostProtectionAttribute Bu sınıfa uygulanan öznitelik şu Resources özellik değerine sahiptir: SharedState. HostProtectionAttribute masaüstü uygulamalarını etkilemez (bunlar normalde bir simge tıklatılarak, komut yazılarak veya tarayıcıya URL girilerek başlatılır). Daha fazla bilgi için bkzHostProtectionAttribute. Programlama ve Konak Koruması Öznitelikleri sınıfı veya SQL Server.

Oluşturucular

RunWorkerCompletedEventArgs(Object, Exception, Boolean)

RunWorkerCompletedEventArgs sınıfının yeni bir örneğini başlatır.

Özellikler

Cancelled	Zaman uyumsuz bir işlemin iptal edilip edilmediğini belirten bir değer alır. (Devralındığı yer: AsyncCompletedEventArgs)
Error	Zaman uyumsuz bir işlem sırasında hangi hatanın oluştuğunu belirten bir değer alır. (Devralındığı yer: AsyncCompletedEventArgs)
Result	Zaman uyumsuz bir işlemin sonucunu temsil eden bir değer alır.
UserState	Kullanıcı durumunu temsil eden bir değer alır.

Yöntemler

Equals(Object)	Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler. (Devralındığı yer: Object)
GetHashCode()	Varsayılan karma işlevi işlevi görür. (Devralındığı yer: Object)
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
RaiseExceptionIfNecessary()	Zaman uyumsuz bir işlem başarısız olursa kullanıcı tarafından sağlanan bir özel durum oluşturur. (Devralındığı yer: AsyncCompletedEventArgs)
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)

Ayrıca bkz.

• BackgroundWorker
• Nasıl yapılır: Arka Planda İşlem Çalıştırma
• Nasıl yapılır: Arka Planda Dosya İndirme