Op Englesch liesen

Deelen iwwer

IWorkProgressHandler Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.RpcContracts.ProgressReporting
Assembly:
Microsoft.VisualStudio.RpcContracts.dll
Package:
Microsoft.VisualStudio.RpcContracts v17.13.7

This interface describes the entity that handles the registration, progress reporting and completion of background work in the Task Status Center.

C# 
public interface IWorkProgressHandler

Methods

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.

Applies to

Produkt Versiounen
Visual Studio SDK 2022