Partilhar via


SourceGeneratedDocument Classe

Definição

Um Document que foi gerado por um ISourceGenerator.

public sealed class SourceGeneratedDocument : Microsoft.CodeAnalysis.Document
type SourceGeneratedDocument = class
    inherit Document
Public NotInheritable Class SourceGeneratedDocument
Inherits Document
Herança
SourceGeneratedDocument

Propriedades

FilePath

O caminho para o arquivo de documento ou nulo se não houver nenhum arquivo de documento.

(Herdado de TextDocument)
Folders

A sequência de pastas lógicas em que o documento está contido.

(Herdado de TextDocument)
HintName

Um Document que foi gerado por um ISourceGenerator.

Id

O identificador do documento. Muitas instâncias de documento podem compartilhar a mesma ID, mas apenas um documento em uma solução pode ter essa ID.

(Herdado de TextDocument)
Name

O nome do documento.

(Herdado de TextDocument)
Project

O projeto ao qual este documento pertence.

(Herdado de TextDocument)
SourceCodeKind

O tipo de código-fonte que este documento contém.

(Herdado de Document)
SupportsSemanticModel

true se este documento der suporte ao fornecimento de dados por meio do GetSemanticModelAsync(CancellationToken) método.

Se false , em seguida, esse método retornará null em vez disso.

(Herdado de Document)
SupportsSyntaxTree

truese este documento der suporte ao fornecimento de dados por meio dos métodos e GetSyntaxRootAsync(CancellationToken) dos GetSyntaxTreeAsync(CancellationToken) métodos.

Se false , em seguida, esses métodos retornarão null .

(Herdado de Document)

Métodos

GetLinkedDocumentIds()

Obtém a lista de DocumentIds que estão vinculados a isso Document. Documents são considerados vinculados se eles compartilham o mesmo FilePath. Isso DocumentId é excluído do resultado.

(Herdado de Document)
GetOptionsAsync(CancellationToken)

Retorna as opções que devem ser aplicadas a este documento. Isso consiste em opções globais de Options, mescladas com todas as configurações especificadas pelo usuário nos níveis do documento.

(Herdado de Document)
GetSemanticModelAsync(CancellationToken)

Obtém o modelo semântico deste documento de forma assíncrona.

(Herdado de Document)
GetSyntaxRootAsync(CancellationToken)

Obtém o nó raiz da árvore de sintaxe de forma assíncrona.

(Herdado de Document)
GetSyntaxTreeAsync(CancellationToken)

Obtém o SyntaxTree para este documento de forma assíncrona.

(Herdado de Document)
GetSyntaxVersionAsync(CancellationToken)

Obtém a versão da árvore de sintaxe. Geralmente, essa é a versão mais recente do texto e da versão do projeto.

(Herdado de Document)
GetTextAsync(CancellationToken)

Obtém o texto atual do documento de forma assíncrona.

(Herdado de TextDocument)
GetTextChangesAsync(Document, CancellationToken)

Obtenha as alterações de texto entre este documento e uma versão anterior do mesmo documento. As alterações, quando aplicadas ao texto do documento antigo, produzirão o texto do documento atual.

(Herdado de Document)
GetTextVersionAsync(CancellationToken)

Obtém a versão do texto do documento.

(Herdado de TextDocument)
TryGetSemanticModel(SemanticModel)

Obtém o modelo semântico atual para este documento se o modelo já estiver computado e ainda estiver armazenado em cache. Em quase todos os casos, você deve chamar GetSemanticModelAsync(CancellationToken), que calculará o modelo semântico, se necessário.

(Herdado de Document)
TryGetSyntaxRoot(SyntaxNode)

Obtém o nó raiz da árvore de sintaxe atual se a árvore de sintaxe já tiver sido analisada e a árvore ainda estiver armazenada em cache. Em quase todos os casos, você deve chamar GetSyntaxRootAsync(CancellationToken) para buscar o nó raiz, que analisará o documento, se necessário.

(Herdado de Document)
TryGetSyntaxTree(SyntaxTree)

Obtenha a árvore de sintaxe atual do documento se o texto já estiver carregado e a árvore já estiver analisada. Em quase todos os casos, você deve chamar GetSyntaxTreeAsync(CancellationToken) para buscar a árvore, que analisará a árvore se ela ainda não estiver analisada.

(Herdado de Document)
TryGetSyntaxVersion(VersionStamp)

Obtenha a versão atual da árvore de sintaxe do documento se o texto já estiver carregado e a árvore já estiver analisada. Em quase todos os casos, você deve chamar GetSyntaxVersionAsync(CancellationToken) para buscar a versão, que carregará a árvore se ela ainda não estiver disponível.

(Herdado de Document)
TryGetText(SourceText)

Obtenha o texto atual do documento se ele já estiver carregado e disponível.

(Herdado de TextDocument)
TryGetTextVersion(VersionStamp)

Obtém a versão do texto do documento se ele já estiver carregado e disponível.

(Herdado de TextDocument)
WithFilePath(String)

Cria uma nova instância deste documento atualizada para ter o caminho de arquivo especificado.

(Herdado de Document)
WithFolders(IEnumerable<String>)

Cria uma nova instância deste documento atualizada para ter as pastas especificadas.

(Herdado de Document)
WithName(String)

Cria uma nova instância deste documento atualizada para ter o nome especificado.

(Herdado de Document)
WithSourceCodeKind(SourceCodeKind)

Cria uma nova instância deste documento atualizada para que o tipo de código-fonte seja especificado.

(Herdado de Document)
WithSyntaxRoot(SyntaxNode)

Cria uma nova instância deste documento atualizada para ter uma árvore de sintaxe enraizada pelo nó de sintaxe especificado.

(Herdado de Document)
WithText(SourceText)

Cria uma nova instância deste documento atualizada para que o texto seja especificado.

(Herdado de Document)

Aplica-se a