DoWorkEventArgs Класс

  • Ссылка

Определение

Пространство имен:
System.ComponentModel
Сборки:
System.dll, System.ComponentModel.EventBasedAsync.dll
Сборка:
System.ComponentModel.EventBasedAsync.dll
Сборка:
System.dll
Сборка:
netstandard.dll
Исходный код:
DoWorkEvent.cs
Исходный код:
DoWorkEvent.cs
Исходный код:
DoWorkEvent.cs

Предоставляет данные для обработчика событий 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
Наследование
Object
EventArgs
DoWorkEventArgs
Наследование
Object
EventArgs
CancelEventArgs
DoWorkEventArgs

Примеры

В следующем примере кода показано, как использовать DoWorkEventArgs класс для обработки DoWork события . Полный список кода см. в разделе Практическое руководство. Выполнение операции в фоновом режиме.

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

Конструкторы

DoWorkEventArgs(Object)

Инициализирует новый экземпляр класса DoWorkEventArgs.

Свойства

Argument

Возвращает значение, представляющее аргумент асинхронной операции.

Cancel

Предоставляет данные для обработчика событий DoWork.
Cancel

Возвращает или задает значение, показывающее, следует ли отменить событие.

(Унаследовано от CancelEventArgs)
Result

Получает или задает значение, представляющее результат асинхронной операции.

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)

Применяется к

См. также раздел