TaskHandlerOptions Struct

Definition

Namespace:

Microsoft.VisualStudio.TaskStatusCenter

Assembly:

Microsoft.VisualStudio.Shell.Framework.dll

Package:

Microsoft.VisualStudio.Shell.Framework v17.12.40391

Holds options for a ITaskHandler that are configured on initialization.

public value class TaskHandlerOptions

public struct TaskHandlerOptions

type TaskHandlerOptions = struct

Public Structure TaskHandlerOptions

Inheritance

ValueType

TaskHandlerOptions

Fields

ActionsAfterCompletion	A value indicating a set of flag(s) that represent the visibility in the Task Status Center UI that the ITaskHandler associated with these options will have upon completion. If any visibility is set then DisplayTaskDetails can not be null.
ClientId	An optional value that clients can specify in order to display tips, either at the start or end of a task. This must be approved by the IDE Exp team via an allow list.
DisplayTaskDetails	A value used to invoke a caller supplied Action<T>. to give more details about the ITaskHandler 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 the task has any visibility after completion regarding CompletionActions, then DisplayTaskDetails can not be null. The Task in the Action<T> will be the Task registered with the IVsTaskStatusCenterService. This will be passed in when DisplayTaskDetails is invoked.
EndTipCalloutId	An optional value that clients can specify in order to display a tip at the completion of a task.
StartTipCalloutId	An optional value that clients can specify in order to display a tip at the start of a task.
TaskSuccessMessage	An optional value that clients can use to specify a customized success message upon completion of task.
Title	A value indicating the title of the ITaskHandler associated with these options.