DoWorkEventArgs Osztály

Definíció

Névtér:

System.ComponentModel

Szerelvények:

netstandard.dll, System.ComponentModel.EventBasedAsync.dll

Forrás:

DoWorkEvent.cs

Adatokat biztosít az DoWork eseménykezelő számára.

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

public class DoWorkEventArgs : System.ComponentModel.CancelEventArgs

type DoWorkEventArgs = class
    inherit CancelEventArgs

Public Class DoWorkEventArgs
Inherits CancelEventArgs

Öröklődés

Object

EventArgs

CancelEventArgs

DoWorkEventArgs

Példák

Az alábbi példakód bemutatja, hogyan használható az osztály az DoWorkEventArgsDoWork esemény kezelésére. A teljes kódlistát lásd : Művelet futtatása a háttérben.

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

Konstruktorok

Name	Description
DoWorkEventArgs(Object)	Inicializálja a DoWorkEventArgs osztály új példányát.

Tulajdonságok

Name	Description
Argument	Olyan értéket kap, amely egy aszinkron művelet argumentumát jelöli.
Cancel	Lekéri vagy beállít egy értéket, amely jelzi, hogy az eseményt le kell-e mondani. (Öröklődés forrása CancelEventArgs)
Result	Lekéri vagy beállít egy aszinkron művelet eredményét képviselő értéket.

Metódusok

Name	Description
Equals(Object)	Meghatározza, hogy a megadott objektum egyenlő-e az aktuális objektummal. (Öröklődés forrása Object)
GetHashCode()	Ez az alapértelmezett kivonatoló függvény. (Öröklődés forrása Object)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)

Lásd még

• BackgroundWorker
• Útmutató: Művelet futtatása a háttérben