Task Class

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

An implementation of IVsTaskItem, used to modify the appearance and functionality of a task in the task list.

public ref class Task : Microsoft::VisualStudio::Shell::Interop::IVsProvideUserContext, Microsoft::VisualStudio::Shell::Interop::IVsTaskItem

[Windows::Foundation::Metadata::WebHostHidden]
class Task : Microsoft::VisualStudio::Shell::Interop::IVsProvideUserContext, Microsoft::VisualStudio::Shell::Interop::IVsTaskItem

[System.Runtime.InteropServices.ComVisible(true)]
public class Task : Microsoft.VisualStudio.Shell.Interop.IVsProvideUserContext, Microsoft.VisualStudio.Shell.Interop.IVsTaskItem

[<System.Runtime.InteropServices.ComVisible(true)>]
type Task = class
    interface IVsTaskItem
    interface IVsProvideUserContext

Public Class Task
Implements IVsProvideUserContext, IVsTaskItem

Inheritance

Object

Task

Derived

Microsoft.VisualStudio.Shell.ErrorTask

Attributes

ComVisibleAttribute

Implements

IVsProvideUserContext IVsTaskItem

Constructors

Task()	Initializes a new instance of Task.
Task(Exception)	Initializes a new instance of Task for the supplied exception.

Fields

contextNameKeyword

Represents the keyword for the user context. This field is constant.

Properties

CanDelete	Gets or sets whether or not the task can be deleted.
Category	Gets or sets the task's category.
Checked	Gets or sets whether not the task's check box is currently selected or cleared.
Column	Gets or sets the column number within the file associated with the task.
Document	Gets or sets the file associated with the task.
HelpKeyword	Gets or sets the Help keyword associated with the task.
ImageIndex	Gets or sets the index of the image associated with the task.
IsCheckedEditable	Gets or sets whether or not it is possible to edit the checked state of the task.
IsPriorityEditable	Gets or sets whether or not it is possible to edit the priority of a task.
IsTextEditable	Gets or sets whether or not it is possible to edit the description of a task.
Line	Gets or sets the line number of the file associated with the task.
Priority	Gets or sets the priority of a task.
SubcategoryIndex	Gets or sets the index of the subcategory of the task.
Text	Gets or sets the description of a task.

Methods

GetUserContext(IVsUserContext)	Creates a new user context.
OnDeleted(EventArgs)	Raised when the task has been deleted.
OnHelp(EventArgs)	Raised when the user requests Help; for example by right-clicking and selecting Show Error Help.
OnNavigate(EventArgs)	Raised when the user attempts to navigate to the task's location in the file, for example by double-clicking on the task.
OnRemoved(EventArgs)	Raised when a task has been removed from the task list.

Events

Deleted	Handles OnDeleted(EventArgs) events.
Help	Handles OnHelp(EventArgs) events.
Navigate	Handles OnNavigate(EventArgs) events.
Removed	Handles OnRemoved(EventArgs) events.

Explicit Interface Implementations

IVsTaskItem.CanDelete(Int32)	Gets whether or not it is possible to delete the task.
IVsTaskItem.Category(VSTASKCATEGORY[])	Sets the task category.
IVsTaskItem.Column(Int32)	Gets the column number of the file associated with the task.
IVsTaskItem.Document(String)	Gets the name of the file associated with the task.
IVsTaskItem.get_Checked(Int32)	Determines whether the task item's check box is currently selected or cleared.
IVsTaskItem.get_Priority(VSTASKPRIORITY[])	Gets the priority of the task.
IVsTaskItem.get_Text(String)	Gets the description of the task.
IVsTaskItem.HasHelp(Int32)	Determines whether or not the task has associated help.
IVsTaskItem.ImageListIndex(Int32)	Gets the index of the image associated with the task.
IVsTaskItem.IsReadOnly(VSTASKFIELD, Int32)	Determines whether or not the specified task field is read-only.
IVsTaskItem.Line(Int32)	Gets the line number of the file associated with the task.
IVsTaskItem.NavigateTo()	Opens a file associated with a task and moves to the appropriate position in the file.
IVsTaskItem.NavigateToHelp()	Opens the Help resource associated with a task.
IVsTaskItem.OnDeleteTask()	Raised when a task has been deleted.
IVsTaskItem.OnFilterTask(Int32)	Raised when a task has been filtered into or out of a view.
IVsTaskItem.put_Checked(Int32)	Sets whether a task item's check box is selected or cleared.
IVsTaskItem.put_Priority(VSTASKPRIORITY)	Sets the priority level of a task item.
IVsTaskItem.put_Text(String)	Sets the description of the task.
IVsTaskItem.SubcategoryIndex(Int32)	Gets the index of the task in the subcategory list.