DoWorkEventArgs Clase

  • Referencia

Definición

Espacio de nombres:
System.ComponentModel
Ensamblados:
System.dll, System.ComponentModel.EventBasedAsync.dll
Ensamblado:
System.ComponentModel.EventBasedAsync.dll
Ensamblado:
System.dll
Ensamblado:
netstandard.dll
Source:
DoWorkEvent.cs
Source:
DoWorkEvent.cs
Source:
DoWorkEvent.cs

Proporciona datos para el controlador de eventos DoWork.

public ref class DoWorkEventArgs : EventArgs
public ref class DoWorkEventArgs : System::ComponentModel::CancelEventArgs
public class DoWorkEventArgs : EventArgs
public class DoWorkEventArgs : System.ComponentModel.CancelEventArgs
type DoWorkEventArgs = class
    inherit EventArgs
type DoWorkEventArgs = class
    inherit CancelEventArgs
Public Class DoWorkEventArgs
Inherits EventArgs
Public Class DoWorkEventArgs
Inherits CancelEventArgs
Herencia
Object
EventArgs
DoWorkEventArgs
Herencia
Object
EventArgs
CancelEventArgs
DoWorkEventArgs

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar la DoWorkEventArgs clase para controlar el DoWork evento. Para obtener una lista de código completa, vea Cómo: Ejecutar una operación en segundo plano.

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;
    }
}

Private Sub backgroundWorker1_DoWork( _
sender As Object, e As DoWorkEventArgs) _
Handles backgroundWorker1.DoWork

   ' Do not access the form's BackgroundWorker reference directly.
   ' Instead, use the reference provided by the sender parameter.
   Dim bw As BackgroundWorker = CType( sender, BackgroundWorker )
   
   ' Extract the argument.
   Dim arg As Integer = Fix(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 Then
      e.Cancel = True
   End If

End Sub

Constructores

DoWorkEventArgs(Object)

Inicializa una nueva instancia de la clase DoWorkEventArgs.

Propiedades

Argument

Obtiene un valor que representa el argumento de una operación asincrónica.
Cancel

Proporciona datos para el controlador de eventos DoWork.
Cancel

Obtiene o establece un valor que indica si se debe cancelar el evento.

(Heredado de CancelEventArgs)
Result

Obtiene o establece un valor que representa el resultado de una operación asincrónica.

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)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)

Se aplica a

Consulte también