RunWorkerCompletedEventArgs Clase

Definición

Espacio de nombres:

System.ComponentModel

Ensamblado:

System.ComponentModel.EventBasedAsync.dll

Source:

RunWorkerCompletedEvent.cs

Proporciona datos para el evento MethodNameCompleted.

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

public class RunWorkerCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs

type RunWorkerCompletedEventArgs = class
    inherit AsyncCompletedEventArgs

Public Class RunWorkerCompletedEventArgs
Inherits AsyncCompletedEventArgs

Herencia

Object

EventArgs

AsyncCompletedEventArgs

RunWorkerCompletedEventArgs

Ejemplos

En el siguiente ejemplo de código, se muestra el uso de RunWorkerCompletedEventArgs. Este ejemplo forma parte de un ejemplo más grande para la BackgroundWorker clase .

// 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

Comentarios

Cuando se usa el patrón asincrónico basado en eventos para las operaciones asincrónicas, un formulario o control de Windows Forms inicia una operación asincrónica mediante una llamada al BackgroundWorker.RunWorkerAsync método . A su vez, el método genera el BackgroundWorker.DoWork evento de forma asincrónica y lo pasa a una DoWorkEventArgs instancia. Si la operación asincrónica devuelve un valor, el BackgroundWorker.DoWork controlador de eventos normalmente lo asigna a la DoWorkEventArgs.Result propiedad . Cuando se completa la operación asincrónica, se genera el BackgroundWorker.RunWorkerCompleted evento y se pasa una RunWorkerCompletedEventArgs instancia que contiene información sobre el estado de la operación (si se canceló, se produjo un error o se completó correctamente). Si se completó correctamente, su Result propiedad contiene el valor devuelto por la operación asincrónica y asignado previamente a la DoWorkEventArgs.Result propiedad .

Nota

El HostProtectionAttribute atributo aplicado a esta clase tiene el siguiente Resources valor de propiedad: SharedState. El atributo HostProtectionAttribute no afecta a las aplicaciones de escritorio (que normalmente se inician haciendo doble clic en un icono, escribiendo un comando o introduciendo una dirección URL en el explorador). Para obtener más información, vea la HostProtectionAttribute clase o SQL Server Atributos de programación y protección de host.

Constructores

RunWorkerCompletedEventArgs(Object, Exception, Boolean)

Inicializa una nueva instancia de la clase RunWorkerCompletedEventArgs.

Propiedades

Cancelled	Obtiene un valor que indica si se ha cancelado una operación asincrónica. (Heredado de AsyncCompletedEventArgs)
Error	Obtiene un valor que indica el error que se produjo durante una operación asincrónica. (Heredado de AsyncCompletedEventArgs)
Result	Obtiene un valor que representa el resultado de una operación asincrónica.
UserState	Obtiene un valor que representa el estado del usuario.

Métodos

Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
RaiseExceptionIfNecessary()	Genera una excepción proporcionada por el usuario si se ha producido un error en una operación asincrónica. (Heredado de AsyncCompletedEventArgs)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Consulte también

• BackgroundWorker
• Cómo: Ejecutar una operación en segundo plano
• Procedimiento para descargar un archivo en segundo plano