BackgroundWorker.OnProgressChanged(ProgressChangedEventArgs) Метод

Определение

Пространство имен:

System.ComponentModel

Сборки:

netstandard.dll, System.ComponentModel.EventBasedAsync.dll

Исходный код:

BackgroundWorker.cs

Вызывает событие ProgressChanged.

protected:
 virtual void OnProgressChanged(System::ComponentModel::ProgressChangedEventArgs ^ e);

protected virtual void OnProgressChanged(System.ComponentModel.ProgressChangedEventArgs e);

abstract member OnProgressChanged : System.ComponentModel.ProgressChangedEventArgs -> unit
override this.OnProgressChanged : System.ComponentModel.ProgressChangedEventArgs -> unit

Protected Overridable Sub OnProgressChanged (e As ProgressChangedEventArgs)

Параметры

e

ProgressChangedEventArgs

Объект EventArgs , содержащий данные события.

Примеры

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

// This method is invoked via the AsyncOperation object,
// so it is guaranteed to be executed on the correct thread.
void CalculateCompleted(object operationState)
{
    CalculatePrimeCompletedEventArgs e =
        operationState as CalculatePrimeCompletedEventArgs;

    OnCalculatePrimeCompleted(e);
}

// This method is invoked via the AsyncOperation object,
// so it is guaranteed to be executed on the correct thread.
void ReportProgress(object state)
{
    ProgressChangedEventArgs e =
        state as ProgressChangedEventArgs;

    OnProgressChanged(e);
}

protected void OnCalculatePrimeCompleted(
    CalculatePrimeCompletedEventArgs e) =>
    CalculatePrimeCompleted?.Invoke(this, e);

protected void OnProgressChanged(ProgressChangedEventArgs e) =>
    ProgressChanged?.Invoke(e);

' This method is invoked via the AsyncOperation object,
' so it is guaranteed to be executed on the correct thread.
Private Sub CalculateCompleted(ByVal operationState As Object)
    Dim e As CalculatePrimeCompletedEventArgs = operationState

    OnCalculatePrimeCompleted(e)

End Sub


' This method is invoked via the AsyncOperation object,
' so it is guaranteed to be executed on the correct thread.
Private Sub ReportProgress(ByVal state As Object)
    Dim e As ProgressChangedEventArgs = state

    OnProgressChanged(e)

End Sub

Protected Sub OnCalculatePrimeCompleted( _
    ByVal e As CalculatePrimeCompletedEventArgs)

    RaiseEvent CalculatePrimeCompleted(Me, e)

End Sub


Protected Sub OnProgressChanged( _
    ByVal e As ProgressChangedEventArgs)

    RaiseEvent ProgressChanged(e)

End Sub

Комментарии

При вызове события обработчик событий вызывается через делегат. Дополнительные сведения см. в разделе "Обработка и создание событий".

Метод OnProgressChanged также позволяет производным классам обрабатывать событие без присоединения делегата. Это предпочтительный способ обработки события в производном классе.

Примечания для тех, кто наследует этот метод

При переопределении OnProgressChanged(ProgressChangedEventArgs) в производном классе обязательно вызовите метод базового класса OnProgressChanged(ProgressChangedEventArgs) , чтобы зарегистрированные делегаты получали событие.

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

• ProgressChanged
• Как выполнить операцию в фоновом режиме
• Практическое руководство. Скачивание файла в фоновом режиме