DoWorkEventArgs Klasse

Definition

Namespace:

System.ComponentModel

Assemblys:

netstandard.dll, System.ComponentModel.EventBasedAsync.dll

Quelle:

DoWorkEvent.cs

Stellt Daten für den DoWork Ereignishandler bereit.

public ref class DoWorkEventArgs : System::ComponentModel::CancelEventArgs

public class DoWorkEventArgs : System.ComponentModel.CancelEventArgs

type DoWorkEventArgs = class
    inherit CancelEventArgs

Public Class DoWorkEventArgs
Inherits CancelEventArgs

Vererbung

Object

EventArgs

CancelEventArgs

DoWorkEventArgs

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie die DoWorkEventArgs Klasse zum Behandeln des Ereignisses DoWork verwendet wird. Eine vollständige Codeauflistung finden Sie unter How to: Run an Operation in the Background.

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

Konstruktoren

Name	Beschreibung
DoWorkEventArgs(Object)	Initialisiert eine neue Instanz der DoWorkEventArgs-Klasse.

Eigenschaften

Name	Beschreibung
Argument	Ruft einen Wert ab, der das Argument eines asynchronen Vorgangs darstellt.
Cancel	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Ereignis abgebrochen werden soll. (Geerbt von CancelEventArgs)
Result	Dient zum Abrufen oder Festlegen eines Werts, der das Ergebnis eines asynchronen Vorgangs darstellt.

Methoden

Name	Beschreibung
Equals(Object)	Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object)
GetHashCode()	Dient als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• BackgroundWorker
• So führen Sie einen Vorgang im Hintergrund aus