IVsTaskItem2 Interface

  • Article

Provides methods for modifying task behavior.

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

Syntax

'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("970A6925-5FFA-4A77-972F-7AB90C0130E5")> _
Public Interface IVsTaskItem2 _
    Inherits IVsTaskItem

[InterfaceTypeAttribute()]
[GuidAttribute("970A6925-5FFA-4A77-972F-7AB90C0130E5")]
public interface IVsTaskItem2 : IVsTaskItem

[InterfaceTypeAttribute()]
[GuidAttribute(L"970A6925-5FFA-4A77-972F-7AB90C0130E5")]
public interface class IVsTaskItem2 : IVsTaskItem

[<InterfaceTypeAttribute()>]
[<GuidAttribute("970A6925-5FFA-4A77-972F-7AB90C0130E5")>]
type IVsTaskItem2 =  
    interface
        interface IVsTaskItem
    end

public interface IVsTaskItem2 extends IVsTaskItem

The IVsTaskItem2 type exposes the following members.

Methods

  Name Description
Public method BrowseObject OBSOLETE. Return E_NOTIMPL.
Public method CanDelete Determines whether a task item can be deleted.
Public method Category Returns the category of a task item.
Public method Column Returns the column number of a task within the specified file.
Public method Document Returns the name of the file associated with a task item.
Public method get_Checked Determines whether the task item's check box is currently selected or cleared.
Public method get_CustomColumnText Returns the text of a customized field for the specified task list view.
Public method get_Priority Returns the priority level of a task item.
Public method get_Text Returns the description of the task item.
Public method HasHelp Obsolete. Return E_NOTIMPL.
Public method ImageListIndex Returns the index into the image list maintained by a provider.
Public method IsCustomColumnReadOnly Determines if a customized task field is set to read-only status.
Public method IsReadOnly Determines whether a specified task field is set to read-only status.
Public method Line Returns the line number of a task item within a specified document.
Public method NavigateTo Opens a file associated with a task item and moves to the appropriate position in the file.
Public method NavigateToHelp Opens the associated help topic.
Public method OnDeleteTask Notifies the task provider that a user has deleted a task.
Public method OnFilterTask Notifies the task provider that a task item has been filtered in or out of view.
Public method put_Checked Sets whether a task item's check box is selected or cleared.
Public method put_CustomColumnText Sets the text of a customized field for the specified task list view.
Public method put_Priority Sets the priority level of a task item.
Public method put_Text Sets the description for a task item.
Public method SubcategoryIndex Returns the index into the subcategory list maintained by a task provider.

Top

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.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace