IVsTaskProgressCollection Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.TaskStatusCenter
Assembly:
Microsoft.VisualStudio.Shell.Framework.dll
Package:
Microsoft.VisualStudio.Shell.Framework v17.9.37000

The IVsTaskProgressCollection represents a set of tasks to be collected together for display as a group in a progress indicator control or in the Task Status Center.

public interface class IVsTaskProgressCollection : System::ComponentModel::INotifyPropertyChanged
public interface IVsTaskProgressCollection : System.ComponentModel.INotifyPropertyChanged
type IVsTaskProgressCollection = interface
    interface INotifyPropertyChanged
Public Interface IVsTaskProgressCollection
Implements INotifyPropertyChanged
Implements
INotifyPropertyChanged

Properties

AllowRunInBackground

Gets or sets a value indicating whether the "Run in Background" button should be visible.
AllowUserCancellation

Gets or sets a value indicating whether the user can cancel the task collection. Default value: true.
AutoUpdateStatus

Gets or sets a value indicating whether the collection's Status should be automatically updated as task statuses change. The default value is true.
CanBeCanceled

Gets a value indicating whether the task collection can canceled. This value is computed based on the CanBeCanceled properties for the incomplete tasks in the collection's Tasks collection.
CanRunInBackground

Gets a value indicating whether the task collection can run without modal UI being displayed for it. This value is computed based on the CanRunInBackground properties for the incomplete tasks in the collection's Tasks collection.
CumulativePercentComplete

Gets the cumulative percent complete of all of the tasks in the collection. It can range from 0 to 100.
CurrentTask

Gets the currently executing task for the collection. This is the first item in the Tasks collection whose status is not one of RanToCompletion, Faulted, or Canceled.
Id

Gets the unique identifier of the task collection.
Status

Gets or sets the status of the task collection.

If AutoUpdateStatus is true, the status is implicitly derived from the statuses of the elements in the Tasks collection. The status cannot be set explicitly.

If AutoUpdateStatus is false, the owner of the collection should set this property explicitly; its value is not derived from the statuses of the elements in the Tasks collection.

Tasks

Gets the set of tasks that comprise the task collection.
Title

Gets the title of the task collection.

Methods

AddTaskAsync(TaskProgressOptions, TaskProgressData, CancellationToken)

Creates a task and adds it to the collection's Tasks collection.
ShowProgress(Boolean)

Displays progress for the task collection. If modal is true, progress is displayed in a dialog and this method will not return until the task collection completes, is canceled, or is moved to the background.

Applies to