This documentation is archived and is not being maintained.

TaskItem Interface

The TaskItem object represents a task item in the Task List window.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

public interface TaskItem

The TaskItem type exposes the following members.

Public propertyCategoryGets a string representing the category of the task item.
Public propertyCheckedSets or gets whether a task item in the Task List window has a check in the check box column.
Public propertyCollectionReturns the collection containing the TaskItem object supporting this property.
Public propertyDescriptionSets or gets a string that represents the description for the TaskItem object.
Public propertyDisplayedGets whether the task item is currently visible in the Task List window.
Public propertyDTEGets the top-level extensibility object.
Public propertyFileNameSets or gets a string representing the file name that was passed to the Task List window when the task item was created.
Public propertyIsSettableReturns whether a given column of a task item can be edited.
Public propertyLineSets or gets the line number of the TaskItem object.
Public propertyPrioritySets or gets a constant that indicates the priority of the task item.
Public propertySubCategoryGets a string representing the task item's subcategory.

Public methodDeleteRemoves the task item from the collection.
Public methodNavigateRequests that the task item navigate to its location and display it, if that is meaningful to the task.
Public methodSelectCauses this item to become active in the integrated development environment (IDE).

In the following example, the tasks appear in the Add-ins and Macros category of the Task List.

[Visual Basic]

Sub TaskItemExample()
   Dim win As Window = DTE.Windows.Item(Constants.vsWindowKindTaskList)
   Dim TL As TaskList = win.Object
   Dim TLItem As TaskItem

   ' Add a couple of tasks to the Task List.
   TLItem = TL.TaskItems.Add(" ", " ", "Test task 1.", vsTaskPriority.vsTaskPriorityHigh, vsTaskIcon.vsTaskIconUser, True, , 10, , )
   TLItem = TL.TaskItems.Add(" ", " ", "Test task 2.", vsTaskPriority.vsTaskPriorityLow, vsTaskIcon.vsTaskIconComment, , 20, , )

   ' List the total number of task list items after adding the new 
   ' task items.
   MsgBox("Task Item 1 description: " & TL.TaskItems.Item(2).Description)
   MsgBox("Total number of task items: " & TL.TaskItems.Count)

   ' Remove the second task item. The items list in reverse numeric order.
   MsgBox("Deleting the second task item")
   MsgBox("Total number of task items: " & TL.TaskItems.Count)
End Sub