TaskItem Interface

 

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

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

[GuidAttribute("58E4D419-6B8C-4C63-92DE-70161CD95890")]
public interface TaskItem

NameDescription
System_CAPS_pubpropertyCategory

Gets a string representing the category of the task item.

System_CAPS_pubpropertyChecked

Sets or gets whether a task item in the Task List window has a check in the check box column.

System_CAPS_pubpropertyCollection

Returns the collection containing the TaskItem object supporting this property.

System_CAPS_pubpropertyDescription

Sets or gets a string that represents the description for the TaskItem object.

System_CAPS_pubpropertyDisplayed

Gets whether the task item is currently visible in the Task List window.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyFileName

Sets or gets a string representing the file name that was passed to the Task List window when the task item was created.

System_CAPS_pubpropertyIsSettable[vsTaskListColumn]

Returns whether a given column of a task item can be edited.

System_CAPS_pubpropertyLine

Sets or gets the line number of the TaskItem object.

System_CAPS_pubpropertyPriority

Sets or gets a constant that indicates the priority of the task item.

System_CAPS_pubpropertySubCategory

Gets a string representing the task item's subcategory.

NameDescription
System_CAPS_pubmethodDelete()

Removes the task item from the collection.

System_CAPS_pubmethodNavigate()

Requests that the task item navigate to its location and display it, if that is meaningful to the task.

System_CAPS_pubmethodSelect()

Causes this item to become active in the integrated development environment (IDE).

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")
   TL.TaskItems.Item(1).Delete()
   MsgBox("Total number of task items: " & TL.TaskItems.Count)
End Sub
Return to top
Show: