ErrorTask Class

Represents an error task on the Task List. This class implements IVsErrorItem.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Shell.Task
    Microsoft.VisualStudio.Shell.ErrorTask
      Microsoft.VisualStudio.Package.DocumentTask

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

Syntax

'Declaration
<ComVisibleAttribute(True)> _
<CLSCompliantAttribute(False)> _
Public Class ErrorTask _
    Inherits Task _
    Implements IVsErrorItem

[ComVisibleAttribute(true)]
[CLSCompliantAttribute(false)]
public class ErrorTask : Task, IVsErrorItem

[ComVisibleAttribute(true)]
[CLSCompliantAttribute(false)]
public ref class ErrorTask : public Task, 
    IVsErrorItem

[<ComVisibleAttribute(true)>]
[<CLSCompliantAttribute(false)>]
type ErrorTask =  
    class
        inherit Task
        interface IVsErrorItem
    end

public class ErrorTask extends Task implements IVsErrorItem

The ErrorTask type exposes the following members.

Constructors

	Name	Description
	ErrorTask()	Initializes a new instance of an ErrorTask.
	ErrorTask(Exception)	Initializes a new instance of an ErrorTask for the specified error.

Top

Properties

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

Top

Methods

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

Top

Events

	Name	Description
	Deleted	Handles OnDeleted events. (Inherited from Task.)
	Help	Handles OnHelp events. (Inherited from Task.)
	Navigate	Handles OnNavigate events. (Inherited from Task.)
	Removed	Handles OnRemoved events. (Inherited from Task.)

Top

Explicit Interface Implementations

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

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