Task Task Task Task Task Class

Definition

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
type Task = class
    interface IVsTaskItem
    interface IVsProvideUserContext
Public Class Task
Implements IVsProvideUserContext, IVsTaskItem
Inheritance
TaskTaskTaskTaskTask
Derived
Attributes
Implements

Constructors

Task() Task() Task() Task() Task()

Initializes a new instance of Task.

Task(Exception) Task(Exception) Task(Exception) Task(Exception) Task(Exception)

Initializes a new instance of Task for the supplied exception.

Fields

contextNameKeyword contextNameKeyword contextNameKeyword contextNameKeyword contextNameKeyword

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

Properties

CanDelete CanDelete CanDelete CanDelete CanDelete

Gets or sets whether or not the task can be deleted.

Category Category Category Category Category

Gets or sets the task's category.

Checked Checked Checked Checked Checked

Gets or sets whether not the task's check box is currently selected or cleared.

Column Column Column Column Column

Gets or sets the column number within the file associated with the task.

Document Document Document Document Document

Gets or sets the file associated with the task.

HelpKeyword HelpKeyword HelpKeyword HelpKeyword HelpKeyword

Gets or sets the Help keyword associated with the task.

ImageIndex ImageIndex ImageIndex ImageIndex ImageIndex

Gets or sets the index of the image associated with the task.

IsCheckedEditable IsCheckedEditable IsCheckedEditable IsCheckedEditable IsCheckedEditable

Gets or sets whether or not it is possible to edit the checked state of the task.

IsPriorityEditable IsPriorityEditable IsPriorityEditable IsPriorityEditable IsPriorityEditable

Gets or sets whether or not it is possible to edit the priority of a task.

IsTextEditable IsTextEditable IsTextEditable IsTextEditable IsTextEditable

Gets or sets whether or not it is possible to edit the description of a task.

Line Line Line Line Line

Gets or sets the line number of the file associated with the task.

Priority Priority Priority Priority Priority

Gets or sets the priority of a task.

SubcategoryIndex SubcategoryIndex SubcategoryIndex SubcategoryIndex SubcategoryIndex

Gets or sets the index of the subcategory of the task.

Text Text Text Text Text

Gets or sets the description of a task.

Methods

GetUserContext(IVsUserContext) GetUserContext(IVsUserContext) GetUserContext(IVsUserContext) GetUserContext(IVsUserContext) GetUserContext(IVsUserContext)

Creates a new user context.

OnDeleted(EventArgs) OnDeleted(EventArgs) OnDeleted(EventArgs) OnDeleted(EventArgs) OnDeleted(EventArgs)

Raised when the task has been deleted.

OnHelp(EventArgs) OnHelp(EventArgs) OnHelp(EventArgs) OnHelp(EventArgs) OnHelp(EventArgs)

Raised when the user requests Help; for example by right-clicking and selecting Show Error Help.

OnNavigate(EventArgs) OnNavigate(EventArgs) OnNavigate(EventArgs) OnNavigate(EventArgs) 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) OnRemoved(EventArgs) OnRemoved(EventArgs) OnRemoved(EventArgs) OnRemoved(EventArgs)

Raised when a task has been removed from the task list.

Events

Deleted Deleted Deleted Deleted Deleted

Handles OnDeleted(EventArgs) events.

Help Help Help Help Help

Handles OnHelp(EventArgs) events.

Navigate Navigate Navigate Navigate Navigate

Handles OnNavigate(EventArgs) events.

Removed Removed Removed Removed Removed

Handles OnRemoved(EventArgs) events.

Explicit Interface Implementations

IVsTaskItem.CanDelete(Int32) IVsTaskItem.CanDelete(Int32) IVsTaskItem.CanDelete(Int32) IVsTaskItem.CanDelete(Int32) IVsTaskItem.CanDelete(Int32)

Gets whether or not it is possible to delete the task.

IVsTaskItem.Category(VSTASKCATEGORY[]) IVsTaskItem.Category(VSTASKCATEGORY[]) IVsTaskItem.Category(VSTASKCATEGORY[]) IVsTaskItem.Category(VSTASKCATEGORY[]) IVsTaskItem.Category(VSTASKCATEGORY[])

Sets the task category.

IVsTaskItem.Column(Int32) IVsTaskItem.Column(Int32) IVsTaskItem.Column(Int32) IVsTaskItem.Column(Int32) IVsTaskItem.Column(Int32)

Gets the column number of the file associated with the task.

IVsTaskItem.Document(String) IVsTaskItem.Document(String) IVsTaskItem.Document(String) IVsTaskItem.Document(String) IVsTaskItem.Document(String)

Gets the name of the file associated with the task.

IVsTaskItem.get_Checked(Int32) IVsTaskItem.get_Checked(Int32) IVsTaskItem.get_Checked(Int32) IVsTaskItem.get_Checked(Int32) IVsTaskItem.get_Checked(Int32)

Determines whether the task item's check box is currently selected or cleared.

IVsTaskItem.get_Priority(VSTASKPRIORITY[]) IVsTaskItem.get_Priority(VSTASKPRIORITY[]) IVsTaskItem.get_Priority(VSTASKPRIORITY[]) IVsTaskItem.get_Priority(VSTASKPRIORITY[]) IVsTaskItem.get_Priority(VSTASKPRIORITY[])

Gets the priority of the task.

IVsTaskItem.get_Text(String) IVsTaskItem.get_Text(String) IVsTaskItem.get_Text(String) IVsTaskItem.get_Text(String) IVsTaskItem.get_Text(String)

Gets the description of the task.

IVsTaskItem.HasHelp(Int32) IVsTaskItem.HasHelp(Int32) IVsTaskItem.HasHelp(Int32) IVsTaskItem.HasHelp(Int32) IVsTaskItem.HasHelp(Int32)

Determines whether or not the task has associated help.

IVsTaskItem.ImageListIndex(Int32) IVsTaskItem.ImageListIndex(Int32) IVsTaskItem.ImageListIndex(Int32) IVsTaskItem.ImageListIndex(Int32) IVsTaskItem.ImageListIndex(Int32)

Gets the index of the image associated with the task.

IVsTaskItem.IsReadOnly(VSTASKFIELD, Int32) IVsTaskItem.IsReadOnly(VSTASKFIELD, Int32) IVsTaskItem.IsReadOnly(VSTASKFIELD, Int32) IVsTaskItem.IsReadOnly(VSTASKFIELD, Int32) IVsTaskItem.IsReadOnly(VSTASKFIELD, Int32)

Determines whether or not the specified task field is read-only.

IVsTaskItem.Line(Int32) IVsTaskItem.Line(Int32) IVsTaskItem.Line(Int32) IVsTaskItem.Line(Int32) IVsTaskItem.Line(Int32)

Gets the line number of the file associated with the task.

IVsTaskItem.NavigateTo() IVsTaskItem.NavigateTo() IVsTaskItem.NavigateTo() IVsTaskItem.NavigateTo() IVsTaskItem.NavigateTo()

Opens a file associated with a task and moves to the appropriate position in the file.

IVsTaskItem.NavigateToHelp() IVsTaskItem.NavigateToHelp() IVsTaskItem.NavigateToHelp() IVsTaskItem.NavigateToHelp() IVsTaskItem.NavigateToHelp()

Opens the Help resource associated with a task.

IVsTaskItem.OnDeleteTask() IVsTaskItem.OnDeleteTask() IVsTaskItem.OnDeleteTask() IVsTaskItem.OnDeleteTask() IVsTaskItem.OnDeleteTask()

Raised when a task has been deleted.

IVsTaskItem.OnFilterTask(Int32) IVsTaskItem.OnFilterTask(Int32) IVsTaskItem.OnFilterTask(Int32) IVsTaskItem.OnFilterTask(Int32) IVsTaskItem.OnFilterTask(Int32)

Raised when a task has been filtered into or out of a view.

IVsTaskItem.put_Checked(Int32) IVsTaskItem.put_Checked(Int32) IVsTaskItem.put_Checked(Int32) IVsTaskItem.put_Checked(Int32) IVsTaskItem.put_Checked(Int32)

Sets whether a task item's check box is selected or cleared.

IVsTaskItem.put_Priority(VSTASKPRIORITY) IVsTaskItem.put_Priority(VSTASKPRIORITY) IVsTaskItem.put_Priority(VSTASKPRIORITY) IVsTaskItem.put_Priority(VSTASKPRIORITY) IVsTaskItem.put_Priority(VSTASKPRIORITY)

Sets the priority level of a task item.

IVsTaskItem.put_Text(String) IVsTaskItem.put_Text(String) IVsTaskItem.put_Text(String) IVsTaskItem.put_Text(String) IVsTaskItem.put_Text(String)

Sets the description of the task.

IVsTaskItem.SubcategoryIndex(Int32) IVsTaskItem.SubcategoryIndex(Int32) IVsTaskItem.SubcategoryIndex(Int32) IVsTaskItem.SubcategoryIndex(Int32) IVsTaskItem.SubcategoryIndex(Int32)

Gets the index of the task in the subcategory list.

Extension Methods

FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)
IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

Applies to