DocumentTask 类

表示语言服务的一个项目。 错误表选项 窗口。

此 API 不兼容 CLS。 

继承层次结构

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

命名空间：  Microsoft.VisualStudio.Package
程序集：   Microsoft.VisualStudio.Package.LanguageService.11.0（在 Microsoft.VisualStudio.Package.LanguageService.11.0.dll 中）
  Microsoft.VisualStudio.Package.LanguageService.9.0（在 Microsoft.VisualStudio.Package.LanguageService.9.0.dll 中）
  Microsoft.VisualStudio.Package.LanguageService（在 Microsoft.VisualStudio.Package.LanguageService.dll 中）
  Microsoft.VisualStudio.Package.LanguageService.10.0（在 Microsoft.VisualStudio.Package.LanguageService.10.0.dll 中）

语法

声明
<CLSCompliantAttribute(False)> _
<ComVisibleAttribute(True)> _
Public Class DocumentTask _
    Inherits ErrorTask _
    Implements IVsTextMarkerClient, IDisposable

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public class DocumentTask : ErrorTask, 
    IVsTextMarkerClient, IDisposable

DocumentTask 类型公开以下成员。

构造函数

	名称	说明
	DocumentTask	初始化 DocumentTask 新实例所指定的文本缓冲区、文本范围和文件名的。

页首

属性

	名称	说明
	CanDelete	获取或设置任务是否能删除。 （继承自 Task。）
	Category	获取或设置任务的类别。 （继承自 Task。）
	Checked	获取或设置没有任务的复选框是否当前未选择也未清除。 （继承自 Task。）
	Column	获取或设置在文件中的列数与任务。 （继承自 Task。）
	Document	获取或设置文件与任务。 （继承自 Task。）
	ErrorCategory	获取或设置此任务错误类别。 （继承自 ErrorTask。）
	HelpKeyword	获取或设置帮助关键字与任务。 （继承自 Task。）
	HierarchyItem	获取或设置层次结构项与此任务。 （继承自 ErrorTask。）
	ImageIndex	获取或设置图像的索引与任务。 （继承自 Task。）
	IsCheckedEditable	获取或设置编辑器任务的选中状态是否是可能的。 （继承自 Task。）
	IsMarkerValid	获取标记是否设置为无效。
	IsPriorityEditable	获取或设置编辑器任务的优先级是否是可能的。 （继承自 Task。）
	IsTextEditable	获取或设置编辑器任务的文档是否是可能的。 （继承自 Task。）
	Line	获取或设置文件中的行号与任务。 （继承自 Task。）
	Priority	获取或设置任务的优先级别。 （继承自 Task。）
	Site	获取服务提供程序。
	Span	获取错误生成的大小。
	SubcategoryIndex	获取或设置任务的子类别的索引。 （继承自 Task。）
	Text	获取或设置任务。 （继承自 Task。）
	TextLineMarker	返回描述错误的位置的文本行标记对象。

页首

方法

	名称	说明
	Dispose()	，在销毁之前，恢复资源 DocumentTask 对象。
	Dispose(Boolean)	，在销毁之前，恢复资源 DocumentTask 对象。
	Equals	确定指定的对象是否等于当前对象。 （继承自 Object。）
	ExecMarkerCommand	对特定标记的命令在文本缓冲区。
	Finalize	，在销毁之前，恢复资源 DocumentTask 对象。 （重写 Object.Finalize()。）
	GetHashCode	用作特定类型的哈希函数。 （继承自 Object。）
	GetMarkerCommandInfo	查询标记对于命令信息。
	GetTipText	获取突出显示的文本标记的提示文本，当鼠标悬停在标记时。
	GetType	获取当前实例的 Type。 （继承自 Object。）
	GetUserContext	创建新用户上下文。 （继承自 Task。）
	MarkerInvalidated	调用，在与标记的文本由用户操作删除。
	MemberwiseClone	创建当前 Object 的浅表副本。 （继承自 Object。）
	OnAfterMarkerChange	标记位置更改的信号。
	OnAfterSpanReload	信号在标记下的文本已修改，但标记尚未删除。
	OnBeforeBufferClose	通知发送文本缓冲区将关闭。
	OnBufferSave	调用，当缓冲区已保存。
	OnDeleted	引发，任务已被删除。 （继承自 Task。）
	OnHelp	引发事件，当用户请求帮助，例如通过右击并选择 显示错误帮助。 （继承自 Task。）
	OnNavigate	加载与错误关联的文档并跳转到错误的位置。 （重写 Task.OnNavigate(EventArgs)。）
	OnRemoved	调用时，此 DocumentTask 对象从 错误表选项 窗口中移除。 （重写 Task.OnRemoved(EventArgs)。）
	ToString	返回表示当前对象的字符串。 （继承自 Object。）

页首

事件

	名称	说明
	Deleted	处理 OnDeleted 事件。 （继承自 Task。）
	Help	处理 OnHelp 事件。 （继承自 Task。）
	Navigate	处理 OnNavigate 事件。 （继承自 Task。）
	Removed	处理 OnRemoved 事件。 （继承自 Task。）

页首

显式接口实现

	名称	说明
	IVsErrorItem.GetCategory	获取错误的类别。 （继承自 ErrorTask。）
	IVsErrorItem.GetHierarchy	获取层次结构节点与任务。 （继承自 ErrorTask。）
	IVsTaskItem.CanDelete	获取删除任务是否是可能的。 （继承自 Task。）
	IVsTaskItem.Category	设置任务类别。 （继承自 Task。）
	IVsTaskItem.Column	获取文件的列数与任务。 （继承自 Task。）
	IVsTaskItem.Document	获取文件的名称与任务。 （继承自 Task。）
	IVsTaskItem.get_Checked	确定任务项的复选框当前是否选中或清除。 （继承自 Task。）
	IVsTaskItem.get_Priority	获取任务的优先级。 （继承自 Task。）
	IVsTaskItem.get_Text	获取任务。 （继承自 Task。）
	IVsTaskItem.HasHelp	确定任务是否关联帮助。 （继承自 Task。）
	IVsTaskItem.ImageListIndex	获取图像的索引与任务。 （继承自 Task。）
	IVsTaskItem.IsReadOnly	确定指定的任务字段是否为只读。 （继承自 Task。）
	IVsTaskItem.Line	获取文件中的行号与任务。 （继承自 Task。）
	IVsTaskItem.NavigateTo	打开文件与任务并移到文件中的相应位置。 （继承自 Task。）
	IVsTaskItem.NavigateToHelp	打开帮助资源与任务。 （继承自 Task。）
	IVsTaskItem.OnDeleteTask	引发，任务已被删除。 （继承自 Task。）
	IVsTaskItem.OnFilterTask	引发，任务筛选到或在视图之外。 （继承自 Task。）
	IVsTaskItem.put_Checked	设置任务项的复选框是否选中或清除。 （继承自 Task。）
	IVsTaskItem.put_Priority	设置任务项的优先级别。 （继承自 Task。）
	IVsTaskItem.put_Text	设置任务。 （继承自 Task。）
	IVsTaskItem.SubcategoryIndex	获取任务的索引在子类别的列表。 （继承自 Task。）

页首

备注

此类是 ErrorTask 类的专用版本并表示报告在分析的问题当前源文件的项。此外，它还支持的功能跳转到导致此错误的行。此类重写 ErrorTask 和 Task 基类并创建托管缓冲区中的某个范围并提供自定义导航。该错误的源的 IVsTextLineMarker 对象。

对实现者的说明

此类包含需要管理在 错误表选项 窗口中的项的所有功能。可以从此类派生更改标记命令行为。此之外，您不必从该类派生。

对调用者的说明

此类的实例在 Source 类的 CreateErrorTaskItem 创建方法。由语言服务分析过程生成的 Source 类使用 DocumentTask 类公开任何警告和错误。通常， DocumentTask 所有实例在内部类别的 Source 类处理。

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。但不保证所有实例成员都是线程安全的。

请参见

参考

Microsoft.VisualStudio.Package 命名空间