Task Class

 

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

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


[ComVisibleAttribute(true)]
public class Task : IVsTaskItem, IVsProvideUserContext

NameDescription
System_CAPS_pubmethodTask()

Initializes a new instance of Task.

System_CAPS_pubmethodTask(Exception)

Initializes a new instance of Task for the supplied exception.

NameDescription
System_CAPS_pubpropertyCanDelete

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

System_CAPS_pubpropertyCategory

Gets or sets the task's category.

System_CAPS_pubpropertyChecked

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

System_CAPS_pubpropertyColumn

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

System_CAPS_pubpropertyDocument

Gets or sets the file associated with the task.

System_CAPS_pubpropertyHelpKeyword

Gets or sets the Help keyword associated with the task.

System_CAPS_pubpropertyImageIndex

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

System_CAPS_pubpropertyIsCheckedEditable

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

System_CAPS_pubpropertyIsPriorityEditable

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

System_CAPS_pubpropertyIsTextEditable

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

System_CAPS_pubpropertyLine

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

System_CAPS_pubpropertyPriority

Gets or sets the priority of a task.

System_CAPS_pubpropertySubcategoryIndex

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

System_CAPS_pubpropertyText

Gets or sets the description of a task.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGetUserContext(IVsUserContext)

Creates a new user context.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnDeleted(EventArgs)

Raised when the task has been deleted.

System_CAPS_protmethodOnHelp(EventArgs)

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

System_CAPS_protmethodOnNavigate(EventArgs)

Raised when the user attempts to navigate to the task's location in the file, for example by double-clicking on the task.

System_CAPS_protmethodOnRemoved(EventArgs)

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

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticcontextNameKeyword

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

NameDescription
System_CAPS_pubeventDeleted

Handles OnDeleted events.

System_CAPS_pubeventHelp

Handles OnHelp events.

System_CAPS_pubeventNavigate

Handles OnNavigate events.

System_CAPS_pubeventRemoved

Handles OnRemoved events.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.CanDelete(Int32)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.Category(VSTASKCATEGORY[])

Sets the task category.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.Column(Int32)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.Document(String)

Gets the name of the file associated with the task.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.get_Checked(Int32)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.get_Priority(VSTASKPRIORITY[])

Gets the priority of the task.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.get_Text(String)

Gets the description of the task.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.HasHelp(Int32)

Determines whether or not the task has associated help.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.ImageListIndex(Int32)

Gets the index of the image associated with the task.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.IsReadOnly(VSTASKFIELD, Int32)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.Line(Int32)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.NavigateTo()

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.NavigateToHelp()

Opens the Help resource associated with a task.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.OnDeleteTask()

Raised when a task has been deleted.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.OnFilterTask(Int32)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.put_Checked(Int32)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.put_Priority(VSTASKPRIORITY)

Sets the priority level of a task item.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.put_Text(String)

Sets the description of the task.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsTaskItem.SubcategoryIndex(Int32)

Gets the index of the task in the subcategory list.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: