DoWorkEventArgs Klasse

Referenz

Definition

Namespace:: System.ComponentModel

Assemblys:: System.dll, System.ComponentModel.EventBasedAsync.dll

Assembly:: System.ComponentModel.EventBasedAsync.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Quelle:: DoWorkEvent.cs

Quelle:: DoWorkEvent.cs

Quelle:: DoWorkEvent.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Stellt Daten für den DoWork-Ereignishandler bereit.

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

Vererbung: Object

EventArgs
DoWorkEventArgs

Vererbung: Object

EventArgs

CancelEventArgs
DoWorkEventArgs

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie Sie die DoWorkEventArgs -Klasse verwenden, um das DoWork Ereignis zu behandeln. Eine vollständige Codeauflistung finden Sie unter Vorgehensweise: Ausführen eines Vorgangs im Hintergrund.

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

Konstruktoren

DoWorkEventArgs(Object)

Initialisiert eine neue Instanz der DoWorkEventArgs-Klasse.

Eigenschaften

Argument	Ruft einen Wert ab, der das Argument eines asynchronen Vorgangs darstellt.
Cancel	Stellt Daten für den DoWork-Ereignishandler bereit.
Cancel	Ruft einen Wert ab, der angibt, ob das Ereignis abgebrochen werden soll, oder legt diesen fest. (Geerbt von CancelEventArgs)
Result	Ruft einen Wert ab, der das Ergebnis eines asynchronen Vorgangs darstellt, oder legt diesen fest.

Methoden

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

Gilt für:

Freigeben über