ITaskHandler2 Interface

  • Reference

Definition

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

Interface representing the objects tracked by the IVsTaskStatusCenterService. These objects are given back to callers to interact with the IVsTaskStatusCenterService with regards to their registered task.

public interface class ITaskHandler2 : Microsoft::VisualStudio::TaskStatusCenter::ITaskHandler
public interface ITaskHandler2 : Microsoft.VisualStudio.TaskStatusCenter.ITaskHandler
type ITaskHandler2 = interface
    interface ITaskHandler
Public Interface ITaskHandler2
Implements ITaskHandler
Implements
ITaskHandler

Properties

Options

Gets a copy of the options configured at initialization for an ITaskHandler behaviour and data.

(Inherited from ITaskHandler)
Progress

Gets the IProgress<T> from this. Can be used to update the behaviour and state of this via Report(T).

(Inherited from ITaskHandler)
UserCancellation

Gets the token that indicates whether the user has requested cancellation.

(Inherited from ITaskHandler)

Methods

Dismiss()

Removes this task from being tracked or presented by the task status center.
RegisterTask(Task)

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

(Inherited from ITaskHandler)

Applies to