DocumentTask Class
Represents an item for a language service in the Error List Options window.
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.Package
Assemblies: Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
Syntax
'Declaration
<CLSCompliantAttribute(False)> _
<ComVisibleAttribute(True)> _
Public Class DocumentTask _
Inherits ErrorTask _
Implements IVsTextMarkerClient, IDisposable
[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public class DocumentTask : ErrorTask,
IVsTextMarkerClient, IDisposable
[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public ref class DocumentTask : public ErrorTask,
IVsTextMarkerClient, IDisposable
[<CLSCompliantAttribute(false)>]
[<ComVisibleAttribute(true)>]
type DocumentTask =
class
inherit ErrorTask
interface IVsTextMarkerClient
interface IDisposable
end
public class DocumentTask extends ErrorTask implements IVsTextMarkerClient, IDisposable
The DocumentTask type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
DocumentTask | Initializes a new instance of DocumentTask for the specified text buffer, text span, and file name. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
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. (Inherited from ErrorTask.) |
|
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. (Inherited from ErrorTask.) |
|
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.) |
|
IsMarkerValid | Gets whether the marker has been set to invalid. |
|
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.) |
|
Site | Gets the service provider. |
|
Span | Gets the span where the error occurred. |
|
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.) |
|
TextLineMarker | Returns the text line marker object that describes the location of the error. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Dispose() | Recovers resources just before the DocumentTask object is destroyed. |
.gif "Protected method") |
Dispose(Boolean) | Recovers resources just before the DocumentTask object is destroyed. |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
ExecMarkerCommand | Executes a command on a specific marker in the text buffer. |
|
Finalize | Recovers resources just before the DocumentTask object is destroyed. (Overrides Object.Finalize().) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetMarkerCommandInfo | Queries the marker for the command information. |
|
GetTipText | Gets the tip text for the text marker that is displayed when the mouse hovers over the marker. |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetUserContext | Creates a new user context. (Inherited from Task.) |
|
MarkerInvalidated | Called when the text that is associated with a marker is deleted by a user action. |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnAfterMarkerChange | Signals that the marker position has changed. |
|
OnAfterSpanReload | Signals that the text under the marker has been altered but the marker has not been deleted. |
|
OnBeforeBufferClose | Sends notification that the text buffer is about to close. |
|
OnBufferSave | Called when the buffer has been saved. |
|
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 | Loads the document that is associated with the error and jumps to the location of the error. (Overrides Task.OnNavigate(EventArgs).) |
|
OnRemoved | Called when this DocumentTask object is removed from the Error List Options window. (Overrides Task.OnRemoved(EventArgs).) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
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 | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IVsErrorItem.GetCategory | Gets the category of the error. (Inherited from ErrorTask.) |
|
IVsErrorItem.GetHierarchy | Gets the hierarchy node associated with the task. (Inherited from ErrorTask.) |
|
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
Remarks
This class is a specialized version of the ErrorTask class and represents an item that reports a problem in the parsing of the current source file. In addition, it supports the functionality of jumping to the line that caused the error. This class overrides the ErrorTask and Task base classes and creates an IVsTextLineMarker object that manages a span in a buffer and provides custom navigation to the source of the error.
Notes to Implementers
This class contains all the functionality that is required to manage an item in the Error List Options window. You can derive from this class to change marker command behaviors. Beyond this, you do not have to derive from this class.
Notes to Callers
An instance of this class is created in the CreateErrorTaskItem method in the Source class. The Source class uses the DocumentTask class to show all warnings and errors that are produced by the language service parser. Typically, the Source class handles all instances of the DocumentTask class internally.
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.