SourceGeneratedDocument Класс

Определение

Пространство имен:

Microsoft.CodeAnalysis

Сборка:

Microsoft.CodeAnalysis.Workspaces.dll

Пакет:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

SourceGeneratedDocument.cs

Объект, Document созданный с помощью .ISourceGenerator

public sealed class SourceGeneratedDocument : Microsoft.CodeAnalysis.Document

type SourceGeneratedDocument = class
    inherit Document

Public NotInheritable Class SourceGeneratedDocument
Inherits Document

Наследование

Object

TextDocument

Document

SourceGeneratedDocument

Свойства

FilePath	Путь к файлу документа или значение NULL, если нет файла документа. (Унаследовано от TextDocument)
Folders	Последовательность логических папок, в которые содержится документ. (Унаследовано от TextDocument)
HintName	Объект, Document созданный с помощью .ISourceGenerator
Id	Идентификатор документа. Многие экземпляры документов могут совместно использовать один и тот же идентификатор, но только один документ в решении может иметь этот идентификатор. (Унаследовано от TextDocument)
Name	Имя документа. (Унаследовано от TextDocument)
Project	Проект, к которому относится этот документ. (Унаследовано от TextDocument)
SourceCodeKind	Тип исходного кода, который содержит этот документ. (Унаследовано от Document)
SupportsSemanticModel	true Значение , если этот документ поддерживает предоставление данных с помощью GetSemanticModelAsync(CancellationToken) метода. Если false этот метод вернет null его. (Унаследовано от Document)
SupportsSyntaxTree	true Значение , если этот документ поддерживает предоставление данных с помощью GetSyntaxTreeAsync(CancellationToken) методов и GetSyntaxRootAsync(CancellationToken) методов. Если false эти методы будут возвращены null . (Унаследовано от Document)

Методы

GetLinkedDocumentIds()	Возвращает список s DocumentId, связанных с этим Document. DocumentS считаются связанными, если они совместно используют одинаковые FilePath. Это DocumentId исключается из результата. (Унаследовано от Document)
GetOptionsAsync(CancellationToken)	Возвращает параметры, которые следует применить к этому документу. Это состоит из глобальных параметров, Optionsобъединенных с любыми параметрами, заданными пользователем на уровнях документа. (Унаследовано от Document)
GetSemanticModelAsync(CancellationToken)	Возвращает семантику модели для этого документа асинхронно. (Унаследовано от Document)
GetSyntaxRootAsync(CancellationToken)	Получает корневой узел дерева синтаксиса асинхронно. (Унаследовано от Document)
GetSyntaxTreeAsync(CancellationToken)	SyntaxTree Получает документ асинхронно. (Унаследовано от Document)
GetSyntaxVersionAsync(CancellationToken)	Возвращает версию дерева синтаксиса. Как правило, это более новая текстовая версия и версия проекта. (Унаследовано от Document)
GetTextAsync(CancellationToken)	Получает текущий текст документа асинхронно. (Унаследовано от TextDocument)
GetTextChangesAsync(Document, CancellationToken)	Получение изменений текста между этим документом и предыдущей версией того же документа. Изменения, примененные к тексту старого документа, будут создавать текст текущего документа. (Унаследовано от Document)
GetTextVersionAsync(CancellationToken)	Возвращает версию текста документа. (Унаследовано от TextDocument)
TryGetSemanticModel(SemanticModel)	Возвращает текущую семантику для этого документа, если модель уже вычисляется и по-прежнему кэшируется. В почти всех случаях следует вызвать GetSemanticModelAsync(CancellationToken)метод, который вычисляет семантику модели при необходимости. (Унаследовано от Document)
TryGetSyntaxRoot(SyntaxNode)	Возвращает корневой узел текущего дерева синтаксиса, если дерево синтаксиса уже проанализировано и дерево по-прежнему кэшируется. Почти во всех случаях необходимо вызвать GetSyntaxRootAsync(CancellationToken) получение корневого узла, который при необходимости будет анализировать документ. (Унаследовано от Document)
TryGetSyntaxTree(SyntaxTree)	Получите текущее дерево синтаксиса для документа, если текст уже загружен и дерево уже проанализировано. Почти во всех случаях следует вызвать GetSyntaxTreeAsync(CancellationToken) получение дерева, которое будет анализировать дерево, если оно еще не проанализировано. (Унаследовано от Document)
TryGetSyntaxVersion(VersionStamp)	Получите текущую версию дерева синтаксиса для документа, если текст уже загружен и дерево уже проанализировано. Почти во всех случаях следует вызвать GetSyntaxVersionAsync(CancellationToken) получение версии, которая загрузит дерево, если оно еще не доступно. (Унаследовано от Document)
TryGetText(SourceText)	Получите текущий текст для документа, если он уже загружен и доступен. (Унаследовано от TextDocument)
TryGetTextVersion(VersionStamp)	Возвращает версию текста документа, если он уже загружен и доступен. (Унаследовано от TextDocument)
WithFilePath(String)	Создает новый экземпляр этого документа, чтобы иметь указанный путь к файлу. (Унаследовано от Document)
WithFolders(IEnumerable<String>)	Создает новый экземпляр этого документа, чтобы иметь указанные папки. (Унаследовано от Document)
WithName(String)	Создает новый экземпляр этого документа, обновленный, чтобы иметь указанное имя. (Унаследовано от Document)
WithSourceCodeKind(SourceCodeKind)	Создает новый экземпляр этого документа, чтобы был указан тип исходного кода. (Унаследовано от Document)
WithSyntaxRoot(SyntaxNode)	Создает новый экземпляр этого документа, чтобы иметь дерево синтаксиса, корневое с помощью указанного узла синтаксиса. (Унаследовано от Document)
WithText(SourceText)	Создает новый экземпляр этого документа, чтобы он был указан. (Унаследовано от Document)