DoWorkEventArgs Třída

Definice

Obor názvů:

System.ComponentModel

Sestavení:

netstandard.dll, System.ComponentModel.EventBasedAsync.dll

Zdroj:

DoWorkEvent.cs

Poskytuje data pro obslužnou rutinu DoWork události.

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

public class DoWorkEventArgs : System.ComponentModel.CancelEventArgs

type DoWorkEventArgs = class
    inherit CancelEventArgs

Public Class DoWorkEventArgs
Inherits CancelEventArgs

Dědičnost

Object

EventArgs

CancelEventArgs

DoWorkEventArgs

Příklady

Následující příklad kódu ukazuje, jak použít DoWorkEventArgs třídu ke zpracování DoWork události. Úplný výpis kódu najdete v tématu Postupy: Spuštění operace na pozadí.

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

Konstruktory

Name	Description
DoWorkEventArgs(Object)	Inicializuje novou instanci DoWorkEventArgs třídy.

Vlastnosti

Name	Description
Argument	Získá hodnotu, která představuje argument asynchronní operace.
Cancel	Získá nebo nastaví hodnotu určující, zda má být událost zrušena. (Zděděno od CancelEventArgs)
Result	Získá nebo nastaví hodnotu, která představuje výsledek asynchronní operace.

Metody

Name	Description
Equals(Object)	Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• BackgroundWorker
• Postupy: Spuštění operace na pozadí