Document 类

定义

命名空间:

Microsoft.CodeAnalysis

程序集:

Microsoft.CodeAnalysis.Workspaces.dll

包:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

Document.cs

表示属于项目的源代码文档。 它提供对源文本、已分析语法树和相应语义模型的访问。

public ref class Document : Microsoft::CodeAnalysis::TextDocument

[System.Diagnostics.DebuggerDisplay("{GetDebuggerDisplay(),nq}")]
public class Document : Microsoft.CodeAnalysis.TextDocument

[<System.Diagnostics.DebuggerDisplay("{GetDebuggerDisplay(),nq}")>]
type Document = class
    inherit TextDocument

Public Class Document
Inherits TextDocument

继承

Object

TextDocument

Document

派生

Microsoft.CodeAnalysis.SourceGeneratedDocument

属性

DebuggerDisplayAttribute

属性

FilePath	文档文件的路径，如果没有文档文件，则为 null。 (继承自 TextDocument)
Folders	文档包含在其中的逻辑文件夹序列。 (继承自 TextDocument)
Id	文档的标识符。 许多文档实例可以共享相同的 ID，但解决方案中只有一个文档可能具有该 ID。 (继承自 TextDocument)
Name	文档的名称。 (继承自 TextDocument)
Project	本文档所属的项目。 (继承自 TextDocument)
SourceCodeKind	本文档包含的源代码类型。
SupportsSemanticModel	true if this Document supports providing data through the GetSemanticModelAsync(CancellationToken) method. 如果是 false ，该方法将改为返回 null 。
SupportsSyntaxTree	true 如果本文档支持通过 GetSyntaxTreeAsync(CancellationToken) 和 GetSyntaxRootAsync(CancellationToken) 方法提供数据， 如果是 false ，则返回这些方法 null 。

方法

GetLinkedDocumentIds()	获取链接到此Document项的列表DocumentId。 Document如果它们共享相同 FilePath，则被视为链接 s。 这会 DocumentId 从结果中排除。
GetOptionsAsync(CancellationToken)	返回应应用于本文档的选项。 这包括全局 Options选项，这些选项与用户已在文档级别指定的任何设置合并。
GetSemanticModelAsync(CancellationToken)	异步获取此文档的语义模型。
GetSyntaxRootAsync(CancellationToken)	异步获取语法树的根节点。
GetSyntaxTreeAsync(CancellationToken)	SyntaxTree异步获取此文档。
GetSyntaxVersionAsync(CancellationToken)	获取语法树的版本。 这通常是较新的文本版本和项目版本。
GetTextAsync(CancellationToken)	异步获取文档的当前文本。 (继承自 TextDocument)
GetTextChangesAsync(Document, CancellationToken)	获取此文档与同一文档的早期版本之间的文本更改。 将更改应用于旧文档的文本时，将生成当前文档的文本。
GetTextVersionAsync(CancellationToken)	获取文档文本的版本。 (继承自 TextDocument)
TryGetSemanticModel(SemanticModel)	如果模型已计算且仍缓存，则获取本文档的当前语义模型。 在几乎所有情况下，都应调用 GetSemanticModelAsync(CancellationToken)，如有必要，该模型将计算语义模型。
TryGetSyntaxRoot(SyntaxNode)	如果已分析语法树并且树仍缓存，则获取当前语法树的根节点。 在几乎所有情况下，都应调用 GetSyntaxRootAsync(CancellationToken) 提取根节点，如有必要，该节点将分析文档。
TryGetSyntaxTree(SyntaxTree)	如果已加载文本并且已分析树，则获取文档的当前语法树。 在几乎所有情况下，都应调用 GetSyntaxTreeAsync(CancellationToken) 提取树，如果树尚未分析，它将分析树。
TryGetSyntaxVersion(VersionStamp)	如果已加载文本并且已分析树，则获取文档的当前语法树版本。 在几乎所有情况下，都应调用 GetSyntaxVersionAsync(CancellationToken) 提取版本，如果树尚不可用，它将加载树。
TryGetText(SourceText)	如果文档已加载且可用，请获取文档的当前文本。 (继承自 TextDocument)
TryGetTextVersion(VersionStamp)	获取文档文本的版本（如果已加载并可用）。 (继承自 TextDocument)
WithFilePath(String)	创建更新为具有指定文件路径的本文档的新实例。
WithFolders(IEnumerable<String>)	创建更新为具有指定文件夹的本文档的新实例。
WithName(String)	创建更新为具有指定名称的本文档的新实例。
WithSourceCodeKind(SourceCodeKind)	创建本文档的新实例以指定源代码类型。
WithSyntaxRoot(SyntaxNode)	创建本文档的新实例，更新为具有以指定语法节点为根的语法树。
WithText(SourceText)	创建更新为指定文本的本文档的新实例。