This documentation is archived and is not being maintained.

IVsTaskItem Interface

Provides methods for modifying task behavior.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

public interface IVsTaskItem

The IVsTaskItem type exposes the following members.

Public methodCanDeleteDetermines whether a task item can be deleted.
Public methodCategoryReturns the category of a task item.
Public methodColumnReturns the column number of a task within the specified file.
Public methodDocumentReturns the name of the file associated with a task item.
Public methodget_CheckedDetermines whether the task item's check box is currently selected or cleared.
Public methodget_PriorityReturns the priority level of a task item.
Public methodget_TextReturns the description of the task item.
Public methodHasHelpObsolete. Return E_NOTIMPL.
Public methodImageListIndexReturns the index into the image list maintained by a provider.
Public methodIsReadOnlyDetermines whether a specified task field is set to read-only status.
Public methodLineReturns the line number of a task item within a specified document.
Public methodNavigateToOpens a file associated with a task item and moves to the appropriate position in the file.
Public methodNavigateToHelpIf there is a help topic for this task item, this method should open it.
Public methodOnDeleteTaskNotifies the task provider that a user has deleted a task.
Public methodOnFilterTaskNotifies the task provider that a task item has been filtered in or out of view.
Public methodput_CheckedSets whether a task item's check box is selected or cleared.
Public methodput_PrioritySets the priority level of a task item.
Public methodput_TextSets the description for a task item.
Public methodSubcategoryIndexReturns the index to the subcategory list maintained by the provider.

The environment implements the IVsTaskList interface to create a container for tasks. To put tasks into the task list, implement IVsTaskProvider2, which specifies a list of task items, each of which is an IVsTaskItem. The IVsTaskItem interface contains methods for modifying the behavior of tasks. The IVsTaskItem2 interface provides methods for managing custom columns.

See illustrations of the implementation of this interface in the sample Figures Language Service.

Notes to Implementers

IVsTaskItem is implemented by task providers to modify the appearance or functionality of a task in the task list. IVsTaskItem2 provides additional methods so task providers can create their own custom views.