IWorkProgressHandler Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This interface describes the entity that handles the registration, progress reporting and completion of background work in the Task Status Center.
public interface IWorkProgressHandlertype IWorkProgressHandler = interfacePublic Interface IWorkProgressHandlerMethods
| CompleteWorkAsync(Guid, CancellationToken) |
A background work running on an extension will call this method to signal to VS that the work has completed. |
| RegisterWorkAsync(String, String, ProgressReporterOptions, CancellationToken) |
Register a background work running on an extension to show up in the Task Status Center. |
| ReportProgressAsync(Guid, ProgressStatus, CancellationToken) |
A background work running on an extension will report back its progress to VS to show in the Task Status Center. |
Events
| WorkCanceled |
An event that will be invoked by VS to notify the extension when user clicks to cancel the running work. |