IVsTaskItem Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Provides methods for modifying task behavior.

public interface class IVsTaskItem

public interface class IVsTaskItem

__interface IVsTaskItem

[System.Runtime.InteropServices.Guid("0F6D7FB4-2649-4E51-BC20-3698F9F51358")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsTaskItem

[<System.Runtime.InteropServices.Guid("0F6D7FB4-2649-4E51-BC20-3698F9F51358")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsTaskItem = interface

Public Interface IVsTaskItem

Derived

Microsoft.VisualStudio.Shell.Interop.IVsTaskItem2

Microsoft.VisualStudio.Shell.Task

Microsoft.VisualStudio.Shell.TaskListItem

Attributes

GuidAttribute InterfaceTypeAttribute

Remarks

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.

Methods

CanDelete(Int32)	Determines whether a task item can be deleted.
Category(VSTASKCATEGORY[])	Returns the category of a task item.
Column(Int32)	Returns the column number of a task within the specified file.
Document(String)	Returns the name of the file associated with a task item.
get_Checked(Int32)	Determines whether the task item's check box is currently selected or cleared.
get_Priority(VSTASKPRIORITY[])	Returns the priority level of a task item.
get_Text(String)	Returns the description of the task item.
HasHelp(Int32)	Obsolete. Return E_NOTIMPL.
ImageListIndex(Int32)	Returns the index into the image list maintained by a provider.
IsReadOnly(VSTASKFIELD, Int32)	Determines whether a specified task field is set to read-only status.
Line(Int32)	Returns the line number of a task item within a specified document.
NavigateTo()	Opens a file associated with a task item and moves to the appropriate position in the file.
NavigateToHelp()	If there is a help topic for this task item, this method should open it.
OnDeleteTask()	Notifies the task provider that a user has deleted a task.
OnFilterTask(Int32)	Notifies the task provider that a task item has been filtered in or out of view.
put_Checked(Int32)	Sets whether a task item's check box is selected or cleared.
put_Priority(VSTASKPRIORITY)	Sets the priority level of a task item.
put_Text(String)	Sets the description for a task item.
SubcategoryIndex(Int32)	Returns the index to the subcategory list maintained by the provider.