IVsTaskProgress Interface

Definition

Namespace:

Microsoft.VisualStudio.TaskStatusCenter

Assembly:

Microsoft.VisualStudio.Shell.Framework.dll

Package:

Microsoft.VisualStudio.Shell.Framework v17.12.40391

An interface representing tasks in an IVsTaskProgressCollection.

public interface class IVsTaskProgress : System::ComponentModel::INotifyPropertyChanged

public interface IVsTaskProgress : System.ComponentModel.INotifyPropertyChanged

type IVsTaskProgress = interface
    interface INotifyPropertyChanged

Public Interface IVsTaskProgress
Implements INotifyPropertyChanged

Implements

INotifyPropertyChanged

Properties

CanBeCanceled	Gets a value indicating whether the task is cancellable at this moment in time. This is updated via Progress.
CanRunInBackground	Gets or sets a value indicating whether the task can run without modal UI being displayed for it.
Options	Gets a copy of the options configured at initialization for an IVsTaskProgress behaviour and data.
PercentComplete	Gets a value indicating the percentage complete the task associated with this is. If this value is null, the progress is indeterminate. This is updated via Progress.
Progress	Gets the IProgress<T> from this. Can be used to update the behaviour and state of this via Report(T). PercentComplete must be between 0 and 100 (inclusive), or null for indeterminate progress.
ProgressText	Gets a string value indicating extra information about the current progress of the task. This is updated via Progress.
Status	Gets a value indicating the status of the task. If this is null, the status of the task is unknown. If no task is registered with this object, Status will be set automatically based on the value of PercentComplete.
Task	The task that was registered with this instance via the RegisterTask(Task) method.
UserCancellation	Gets the token that indicates whether the user has requested cancellation.

Methods

RegisterTask(Task)

Registers task with the IVsTaskStatusCenterService that the caller wants to have tracked. Task will be displayed in the IVsTaskStatusCenterService UI.