TaskProgressOptions Class

Definition

Namespace:

Microsoft.VisualStudio.TaskStatusCenter

Assembly:

Microsoft.VisualStudio.Shell.Framework.dll

Package:

Microsoft.VisualStudio.Shell.Framework v17.12.40391

Holds immutable options for an IVsTaskProgress.

public ref class TaskProgressOptions

public class TaskProgressOptions

type TaskProgressOptions = class

Public Class TaskProgressOptions

Inheritance

Object

TaskProgressOptions

Constructors

TaskProgressOptions(String, CompletionActions, Action<Task>)	Initializes a new instance of the TaskProgressOptions class.
TaskProgressOptions(String, Stream, IVsProgressStreamConverter, CompletionActions, Action<Task>, LogDisplayType, Object)	Obsolete. Initializes a new instance of the TaskProgressOptions class.
TaskProgressOptions(String)	Initializes a new instance of the TaskProgressOptions class.

Fields

ProgressStream	Obsolete. An optional stream which shows the progress of a task. This stream output will be rendered in a UI like the output window. If no StreamConverter is specified, the raw stream output will be displayed.
StreamConverter	Obsolete. An optional stream converter that would convert a ProgressStream into a format that is displayed in a UI.

Properties

CompletionActions	Gets a value indicating a set of flag(s) that represent the visibility in the Task Status Center UI that the IVsTaskProgress associated with these options will have upon completion.
Display	Obsolete. The object that will be used to display the output. For e.g. IVsOutputWindowPane when the DisplayType is OutputWindow.
DisplayTaskDetails	Gets a value used to invoke a caller supplied Action<T>. to give more details about the IVsTaskProgress associated with this, to the user. Could lead the user to the tool window associated with the task, or open up an error log for example. The Task passed to the action will be the Task registered with the IVsTaskProgress.
DisplayType	Obsolete. Gets a property that indicates where the output of the tasks associated with the IVsTaskProgress would go.
Title	Gets a value indicating the title of the IVsTaskProgress associated with these options.