Project 类

定义

表示属于 的项目 Solution

public ref class Project
[System.Diagnostics.DebuggerDisplay("{GetDebuggerDisplay(),nq}")]
public class Project
[<System.Diagnostics.DebuggerDisplay("{GetDebuggerDisplay(),nq}")>]
type Project = class
Public Class Project
继承
Project
属性

属性

AdditionalDocumentIds

与此项目关联的所有其他文档 ID。

AdditionalDocuments

与此项目关联的所有其他文档。

AllProjectReferences

此项目引用的所有其他项目的列表,包括不属于解决方案的项目。

AnalyzerConfigDocuments

AnalyzerConfigDocument与此项目关联的所有 。

AnalyzerOptions

分析器用于此项目的选项。

AnalyzerReferences

此项目的所有诊断分析器引用的列表。

AssemblyName

此项目表示的程序集的名称。

CompilationOptions

生成此项目的编译时使用的选项。

CompilationOutputInfo

编译输出文件路径。

DefaultNamespace

如果未定义,则项目的默认命名空间 (“”,这意味着全局命名空间) ;如果未知或不适用,则为 null。

DocumentIds

与此项目关联的所有文档 ID。

Documents

与此项目关联的所有常规文档。 从源生成器生成的文档由 GetSourceGeneratedDocumentsAsync(CancellationToken)返回。

FilePath

项目文件的路径;如果没有项目文件,则为 null。

HasDocuments

如果项目包含任何文档,则为 True。

Id

项目的 ID。 多个 Project 实例可以共享同一 ID。 但是,在任何给定的解决方案中,只有一个项目可能具有此 ID。

IsSubmission

如果这是提交项目,则返回 true。

Language

与项目关联的语言。

LanguageServices
已过时.

与此项目的语言关联的主机环境中的语言服务。

MetadataReferences

此项目引用的所有其他元数据源 (程序集) 的列表。

Name

项目的名称。 这可能不同于程序集名称。

OutputFilePath

输出文件的路径;如果未知,则为 null。

OutputRefFilePath

引用程序集输出文件的路径;如果未知,则为 null。

ParseOptions

分析此项目的文档时使用的选项。

ProjectReferences

此项目引用的同一解决方案中的所有其他项目的列表。

Services

与此项目的语言关联的主机环境中的语言服务的不可变快照。 如果可能,请用到 。LanguageServices

Solution

此项目所属的解决方案。

SupportsCompilation

true 如果这 Project 支持通过 方法提供数据,则 GetCompilationAsync(CancellationToken) 为 。

如果 false 为 , GetCompilationAsync(CancellationToken) 则 方法将改为返回 null

Version

项目版本。 这相当于项目文件的版本。

方法

AddAdditionalDocument(String, SourceText, IEnumerable<String>, String)

在此项目的新实例中创建一个新的附加文档。

AddAdditionalDocument(String, String, IEnumerable<String>, String)

在此项目的新实例中创建一个新的附加文档。

AddAnalyzerConfigDocument(String, SourceText, IEnumerable<String>, String)

在此项目的新实例中创建新的分析器配置文档。

AddAnalyzerReference(AnalyzerReference)

创建此项目的新实例,更新为包含指定的分析器引用以及现有分析器引用。

AddAnalyzerReferences(IEnumerable<AnalyzerReference>)

创建此项目的新实例,更新为除现有分析器引用外还包括指定的分析器引用。

AddDocument(String, SourceText, IEnumerable<String>, String)

在此项目的新实例中创建新文档。

AddDocument(String, String, IEnumerable<String>, String)

在此项目的新实例中创建新文档。

AddDocument(String, SyntaxNode, IEnumerable<String>, String)

在此项目的新实例中创建新文档。

AddMetadataReference(MetadataReference)

创建此项目的新实例,更新为包含指定的元数据引用以及现有元数据引用。

AddMetadataReferences(IEnumerable<MetadataReference>)

创建此项目的新实例,更新为包含指定的元数据引用以及现有的元数据引用。

AddProjectReference(ProjectReference)

创建此项目的新实例,更新为包含指定的项目引用以及现有项目引用。

AddProjectReferences(IEnumerable<ProjectReference>)

创建此项目的新实例,更新为包含指定的项目引用以及现有的引用。

ContainsAdditionalDocument(DocumentId)

如此 如果项目包含具有指定 ID 的其他文档。

ContainsAnalyzerConfigDocument(DocumentId)

如此 如果项目包含 AnalyzerConfigDocument 具有指定 ID 的 。

ContainsDocument(DocumentId)

如此 如果项目包含具有指定 ID 的文档。

GetAdditionalDocument(DocumentId)

获取此项目中具有指定文档 ID 的其他文档。

GetAnalyzerConfigDocument(DocumentId)

获取此项目中具有指定文档 ID 的分析器配置文档。

GetChanges(Project)

获取一个 对象,该对象列出此项目和指定项目之间添加、更改和删除的文档。

GetCompilationAsync(CancellationToken)

Compilation异步获取此项目的 。

GetDependentSemanticVersionAsync(CancellationToken)

此项目的语义版本,包括所引用项目的语义。 每当此项目的易耗品声明和/或项目依赖于更改时,此版本会更改。

GetDependentVersionAsync(CancellationToken)

项目的最新版本、其文档以及所有相关项目和文档。

GetDocument(DocumentId)

获取此项目中具有指定文档 ID 的文档。

GetDocument(SyntaxTree)

获取此项目中具有指定语法树的文档。

GetDocumentId(SyntaxTree)

使用指定的语法树获取此项目中的 documentId。

GetLatestDocumentVersionAsync(CancellationToken)

最近修改的文档的版本。

GetSemanticVersionAsync(CancellationToken)

此项目的语义版本,不包括所引用项目的语义。 仅当此项目的易耗品声明发生更改时,此版本才会更改。

GetSourceGeneratedDocumentAsync(DocumentId, CancellationToken)

表示属于 的项目 Solution

GetSourceGeneratedDocumentsAsync(CancellationToken)

获取此项目中所有源生成的文档。

RemoveAdditionalDocument(DocumentId)

创建此项目的新实例,更新为不再包含指定的附加文档。

RemoveAdditionalDocuments(ImmutableArray<DocumentId>)

创建此项目的新实例,更新为不再包含指定的其他文档。

RemoveAnalyzerConfigDocument(DocumentId)

创建此项目的新实例,更新为不再包含指定的分析器配置文档。

RemoveAnalyzerConfigDocuments(ImmutableArray<DocumentId>)

创建不再包含指定 AnalyzerConfigDocument的新解决方案实例。

RemoveAnalyzerReference(AnalyzerReference)

创建此项目的新实例,更新为不再包含指定的分析器引用。

RemoveDocument(DocumentId)

创建此项目的新实例,更新为不再包含指定的文档。

RemoveDocuments(ImmutableArray<DocumentId>)

创建此项目的新实例,更新为不再包含指定的文档。

RemoveMetadataReference(MetadataReference)

创建此项目的新实例,更新为不再包含指定的元数据引用。

RemoveProjectReference(ProjectReference)

创建此项目的新实例,更新为不再包含指定的项目引用。

TryGetCompilation(Compilation)

如果已创建并仍缓存该项目,则尝试获取 Compilation 该项目的缓存。 在几乎所有情况下,都应调用 GetCompilationAsync(CancellationToken) ,它将返回缓存 Compilation 的 ,否则将创建一个新缓存。

WithAnalyzerReferences(IEnumerable<AnalyzerReference>)

创建此项目的新实例,更新为将现有分析器引用替换为指定的引用。

WithAssemblyName(String)

创建此项目的新实例,更新为具有新的程序集名称。

WithCompilationOptions(CompilationOptions)

创建此项目的新实例,更新为具有指定的编译选项。

WithDefaultNamespace(String)

创建此项目的新实例,更新为具有新的默认命名空间。

WithMetadataReferences(IEnumerable<MetadataReference>)

创建此项目的新实例,更新为将现有元数据引用替换为指定的元数据引用。

WithParseOptions(ParseOptions)

创建此项目的新实例,更新为具有指定的分析选项。

WithProjectReferences(IEnumerable<ProjectReference>)

创建此项目的新实例,更新为将现有项目引用替换为指定的引用。

适用于