TaskProgressOptions Constructors

Definition

Namespace:

Microsoft.VisualStudio.TaskStatusCenter

Assembly:

Microsoft.VisualStudio.Shell.Framework.dll

Package:

Microsoft.VisualStudio.Shell.Framework v17.9.37000

Overloads

TaskProgressOptions(String)	Initializes a new instance of the TaskProgressOptions class.
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.

public:
 TaskProgressOptions(System::String ^ title);

public TaskProgressOptions (string title);

new Microsoft.VisualStudio.TaskStatusCenter.TaskProgressOptions : string -> Microsoft.VisualStudio.TaskStatusCenter.TaskProgressOptions

Public Sub New (title As String)

Parameters

title

String

The title of the collection.

TaskProgressOptions(String, CompletionActions, Action<Task>)

Initializes a new instance of the TaskProgressOptions class.

public:
 TaskProgressOptions(System::String ^ title, Microsoft::VisualStudio::TaskStatusCenter::CompletionActions completionActions, Action<System::Threading::Tasks::Task ^> ^ displayTaskDetails);

public TaskProgressOptions (string title, Microsoft.VisualStudio.TaskStatusCenter.CompletionActions completionActions, Action<System.Threading.Tasks.Task>? displayTaskDetails);

new Microsoft.VisualStudio.TaskStatusCenter.TaskProgressOptions : string * Microsoft.VisualStudio.TaskStatusCenter.CompletionActions * Action<System.Threading.Tasks.Task> -> Microsoft.VisualStudio.TaskStatusCenter.TaskProgressOptions

Public Sub New (title As String, completionActions As CompletionActions, displayTaskDetails As Action(Of Task))

Parameters

title

String

The title of the collection.

completionActions

CompletionActions

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. If this value is something other than None, then displayTaskDetails can not be null.

displayTaskDetails

Action<Task>

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. If completionActions is something other than None, then this parameter can not be null. The Task passed to the action will be the Task registered with the IVsTaskProgress.

TaskProgressOptions(String, Stream, IVsProgressStreamConverter, CompletionActions, Action<Task>, LogDisplayType, Object)

Caution

Progress indicator no longer supports progress streams.

Initializes a new instance of the TaskProgressOptions class.

public:
 TaskProgressOptions(System::String ^ title, System::IO::Stream ^ progressStream, Microsoft::VisualStudio::TaskStatusCenter::IVsProgressStreamConverter ^ streamConverter, Microsoft::VisualStudio::TaskStatusCenter::CompletionActions completionActions, Action<System::Threading::Tasks::Task ^> ^ displayTaskDetails, Microsoft::VisualStudio::TaskStatusCenter::LogDisplayType displayType, System::Object ^ display);

[System.Obsolete("Progress indicator no longer supports progress streams.")]
public TaskProgressOptions (string title, System.IO.Stream? progressStream, Microsoft.VisualStudio.TaskStatusCenter.IVsProgressStreamConverter? streamConverter, Microsoft.VisualStudio.TaskStatusCenter.CompletionActions completionActions, Action<System.Threading.Tasks.Task>? displayTaskDetails, Microsoft.VisualStudio.TaskStatusCenter.LogDisplayType displayType, object? display);

[<System.Obsolete("Progress indicator no longer supports progress streams.")>]
new Microsoft.VisualStudio.TaskStatusCenter.TaskProgressOptions : string * System.IO.Stream * Microsoft.VisualStudio.TaskStatusCenter.IVsProgressStreamConverter * Microsoft.VisualStudio.TaskStatusCenter.CompletionActions * Action<System.Threading.Tasks.Task> * Microsoft.VisualStudio.TaskStatusCenter.LogDisplayType * obj -> Microsoft.VisualStudio.TaskStatusCenter.TaskProgressOptions

Public Sub New (title As String, progressStream As Stream, streamConverter As IVsProgressStreamConverter, completionActions As CompletionActions, displayTaskDetails As Action(Of Task), displayType As LogDisplayType, display As Object)

Parameters

title

String

The title of the collection.

progressStream

Stream

A stream that would provide progress of the task.

streamConverter

IVsProgressStreamConverter

A stream converter that can convert the stream to a displayable format.

completionActions

CompletionActions

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. If this value is something other than None, then displayTaskDetails can not be null.

displayTaskDetails

Action<Task>

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. If completionActions is something other than None, then this parameter can not be null. The Task passed to the action will be the Task registered with the IVsTaskProgress.

displayType

LogDisplayType

A DisplayType enum where information should be displayed in a persistent manner. e.g. Output Window.

display

Object

If displayType is None this should be null. If the displayType is OutputWindow then display should be IVsOutputWindowPane.

Attributes

ObsoleteAttribute