Share via


Task Class

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

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Shell.Task
    Microsoft.VisualStudio.Shell.ErrorTask

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

Syntax

'Declaration
<ComVisibleAttribute(True)> _
Public Class Task _
    Implements IVsTaskItem, IVsProvideUserContext
[ComVisibleAttribute(true)]
public class Task : IVsTaskItem, IVsProvideUserContext
[ComVisibleAttribute(true)]
public ref class Task : IVsTaskItem, IVsProvideUserContext
[<ComVisibleAttribute(true)>]
type Task =  
    class 
        interface IVsTaskItem 
        interface IVsProvideUserContext 
    end
public class Task implements IVsTaskItem, IVsProvideUserContext

The Task type exposes the following members.

Constructors

  Name Description
Public method Task() Initializes a new instance of Task.
Public method Task(Exception) Initializes a new instance of Task for the supplied exception.

Top

Properties

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

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUserContext Creates a new user context.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnDeleted Raised when the task has been deleted.
Protected method OnHelp Raised when the user requests Help; for example by right-clicking and selecting Show Error Help.
Protected method OnNavigate Raised when the user attempts to navigate to the task's location in the file, for example by double-clicking on the task.
Protected method OnRemoved Raised when a task has been removed from the task list.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event Deleted Handles OnDeleted events.
Public event Help Handles OnHelp events.
Public event Navigate Handles OnNavigate events.
Public event Removed Handles OnRemoved events.

Top

Fields

  Name Description
Public fieldStatic member contextNameKeyword Represents the keyword for the user context. This field is constant.

Top

Explicit Interface Implementations

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

Top

Thread Safety

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

See Also

Reference

Microsoft.VisualStudio.Shell Namespace