Tutorial: Ejecutar una operación en segundo plano

1. Con el formulario activo en el Diseñador de Windows Forms, arrastre dos controles Button del Cuadro de herramientas al formulario y después establezca las propiedades Name y Text de los botones de acuerdo con la tabla siguiente.

   Botón	Nombre	Texto
   button1	startBtn	Iniciar
   button2	cancelBtn	Cancelar

2. Abra el Cuadro de herramientas, haga clic en la ficha Componentes y, a continuación, arrastre el componente BackgroundWorker al formulario.

   Aparecerá el componente backgroundWorker1 en la Bandeja de componentes.

3. En la ventana Propiedades, haga clic en el botón Eventos y, a continuación, haga doble clic en los eventos DoWork y RunWorkerCompleted para crear los controladores de eventos.

4. Inserte el código que lleva mucho tiempo en el controlador de eventos DoWork.

5. Extraiga los parámetros necesarios para la operación de la propiedad Argument del parámetro DoWorkEventArgs.

6. Asigne el resultado del cálculo a la propiedad Result de DoWorkEventArgs.

   Éste estará disponible al controlador de eventos RunWorkerCompleted.

   C#

   VB

   Copiar

   private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
   {
       // Do not access the form's BackgroundWorker reference directly.
       // Instead, use the reference provided by the sender parameter.
       BackgroundWorker bw = sender as BackgroundWorker;
   
       // Extract the argument.
       int arg = (int)e.Argument;
   
       // Start the time-consuming operation.
       e.Result = TimeConsumingOperation(bw, arg);
   
       // If the operation was canceled by the user, 
       // set the DoWorkEventArgs.Cancel property to true.
       if (bw.CancellationPending)
       {
           e.Cancel = true;
       }
   }
   
   

7. Inserte el código para recuperar el resultado de la operación en el controlador de eventos RunWorkerCompleted.

   C#

   VB

   Copiar

   // This event handler demonstrates how to interpret 
   // the outcome of the asynchronous operation implemented
   // in the DoWork event handler.
   private void backgroundWorker1_RunWorkerCompleted(
       object sender, 
       RunWorkerCompletedEventArgs e)
   {   
       if (e.Cancelled)
       {
           // The user canceled the operation.
           MessageBox.Show("Operation was canceled");
       }
       else if (e.Error != null)
       {
           // There was an error during the operation.
           string msg = String.Format("An error occurred: {0}", e.Error.Message);
           MessageBox.Show(msg);
       }
       else
       {
           // The operation completed normally.
           string msg = String.Format("Result = {0}", e.Result);
           MessageBox.Show(msg);
       }
   }
   
   

8. Implemente el método TimeConsumingOperation.

   C#

   VB

   Copiar

   // This method models an operation that may take a long time 
   // to run. It can be cancelled, it can raise an exception,
   // or it can exit normally and return a result. These outcomes
   // are chosen randomly.
   private int TimeConsumingOperation( 
       BackgroundWorker bw, 
       int sleepPeriod )
   {
       int result = 0;
   
       Random rand = new Random();
   
       while (!this.backgroundWorker1.CancellationPending)
       {
           bool exit = false;
   
           switch (rand.Next(3))
           {
               // Raise an exception.
               case 0:
               {
                   throw new Exception("An error condition occurred.");
                   break;
               }
   
               // Sleep for the number of milliseconds
               // specified by the sleepPeriod parameter.
               case 1:
               {
                   Thread.Sleep(sleepPeriod);
                   break;
               }
   
               // Exit and return normally.
               case 2:
               {
                   result = 23;
                   exit = true;
                   break;
               }
   
               default:
               {
                   break;
               }
           }
   
           if( exit )
           {
               break;
           }
       }
   
       return result;
   }
   
   

9. En el Diseñador de Windows Forms, haga doble clic en startButton para crear el controlador de eventos Click.

10. Llame al método RunWorkerAsync en el controlador de eventos Click para startButton.

    C#

    VB

    Copiar

    private void startBtn_Click(object sender, EventArgs e)
    {
        this.backgroundWorker1.RunWorkerAsync(2000);
    }
    
    

11. En el Diseñador de Windows Forms, haga doble clic en cancelButton para crear el controlador de eventos Click.

12. Llame al método CancelAsync en el controlador de eventos Click para cancelButton.

    C#

    VB

    Copiar

    private void startBtn_Click(object sender, EventArgs e)
    {
        this.backgroundWorker1.RunWorkerAsync(2000);
    }
    
    

13. Presione F6 para generar la solución y, a continuación, presione CTRL-F5 para ejecutar la aplicación fuera del depurador.

Nota
Si presiona F5 para ejecutar la aplicación bajo el depurador, éste detectará y mostrará la excepción generada en el método TimeConsumingOperation. Cuando ejecuta la aplicación fuera del depurador, BackgroundWorker controla la excepción y la almacena en memoria caché en la propiedad Error de RunWorkerCompletedEventArgs.

1. Haga clic en el botón Iniciar para ejecutar una operación asincrónica y, a continuación, haga clic en el botón Cancelar para detener una operación asincrónica en ejecución.

   El resultado de cada operación se muestra en MessageBox.

• Implemente un formulario que informa del progreso a medida que prosigue la operación asincrónica. Para obtener más información, vea Cómo: Implementar un formulario que utiliza una operación en segundo plano.

• Implemente una clase que admite el Modelo asincrónico para componentes. Para obtener más información, vea Implementar el modelo asincrónico basado en eventos.

Tareas

Referencia

Otros recursos