Share via

ProgressReporter Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Extensibility.Shell
Assembly:
Microsoft.VisualStudio.Extensibility.dll
Package:
Microsoft.VisualStudio.Extensibility v17.11.350

An entity that inherits IProgress<T> used by background work running on an extension to report progress.

public class ProgressReporter : IDisposable, IProgress<Microsoft.VisualStudio.RpcContracts.ProgressReporting.ProgressStatus>
type ProgressReporter = class
    interface IProgress<ProgressStatus>
    interface IDisposable
Public Class ProgressReporter
Implements IDisposable, IProgress(Of ProgressStatus)
Inheritance
Object
ProgressReporter
Implements
IDisposable IProgress<ProgressStatus>

Properties

CancellationToken

Gets the cancellation token that provides to the extension for cancelling an ongoing background work.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose(Boolean)

Disposes the instance and underlying proxies.
OnWorkCanceled(Object, WorkCanceledEventArgs)

Cancel the ongoing background work in the extension after WorkCanceled event has been triggered.
Report(ProgressStatus)

Inherited from IProgress<T>.

Applies to