Compartir a través de


SourceGeneratedDocument Clase

Definición

objeto Document generado por un ISourceGeneratorobjeto .

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

Propiedades

FilePath

Ruta de acceso al archivo de documento o null si no hay ningún archivo de documento.

(Heredado de TextDocument)
Folders

Secuencia de carpetas lógicas en las que se encuentra el documento.

(Heredado de TextDocument)
HintName

objeto Document generado por un ISourceGeneratorobjeto .

Id

Identificador del documento. Muchas instancias de documento pueden compartir el mismo identificador, pero solo un documento de una solución puede tener ese identificador.

(Heredado de TextDocument)
Name

Nombre del documento.

(Heredado de TextDocument)
Project

El proyecto al que pertenece este documento.

(Heredado de TextDocument)
SourceCodeKind

El tipo de código fuente que contiene este documento.

(Heredado de Document)
SupportsSemanticModel

true si este documento admite proporcionar datos a través del GetSemanticModelAsync(CancellationToken) método .

Si false ese método se devolverá null en su lugar.

(Heredado de Document)
SupportsSyntaxTree

true si este documento admite la provisión de datos a través de los GetSyntaxTreeAsync(CancellationToken) métodos y GetSyntaxRootAsync(CancellationToken) .

Si false , en su lugar, estos métodos se devolverán null .

(Heredado de Document)

Métodos

GetLinkedDocumentIds()

Obtiene la lista de DocumentIdlos que están vinculados a este Documentobjeto . Documentse consideran vinculados si comparten el mismo FilePath. Esto DocumentId se excluye del resultado.

(Heredado de Document)
GetOptionsAsync(CancellationToken)

Devuelve las opciones que se deben aplicar a este documento. Esto consta de opciones globales de Options, combinadas con cualquier configuración que el usuario haya especificado en los niveles de documento.

(Heredado de Document)
GetSemanticModelAsync(CancellationToken)

Obtiene el modelo semántico de este documento de forma asincrónica.

(Heredado de Document)
GetSyntaxRootAsync(CancellationToken)

Obtiene el nodo raíz del árbol de sintaxis de forma asincrónica.

(Heredado de Document)
GetSyntaxTreeAsync(CancellationToken)

Obtiene para SyntaxTree este documento de forma asincrónica.

(Heredado de Document)
GetSyntaxVersionAsync(CancellationToken)

Obtiene la versión del árbol de sintaxis. Por lo general, es la versión más reciente de texto y la versión del proyecto.

(Heredado de Document)
GetTextAsync(CancellationToken)

Obtiene el texto actual del documento de forma asincrónica.

(Heredado de TextDocument)
GetTextChangesAsync(Document, CancellationToken)

Obtenga los cambios de texto entre este documento y una versión anterior del mismo documento. Los cambios, cuando se aplican al texto del documento antiguo, producirán el texto del documento actual.

(Heredado de Document)
GetTextVersionAsync(CancellationToken)

Obtiene la versión del texto del documento.

(Heredado de TextDocument)
TryGetSemanticModel(SemanticModel)

Obtiene el modelo semántico actual de este documento si el modelo ya está calculado y todavía almacenado en caché. En casi todos los casos, debe llamar a GetSemanticModelAsync(CancellationToken), que calculará el modelo semántico si es necesario.

(Heredado de Document)
TryGetSyntaxRoot(SyntaxNode)

Obtiene el nodo raíz del árbol de sintaxis actual si el árbol de sintaxis ya se ha analizado y el árbol todavía está almacenado en caché. En casi todos los casos, debe llamar GetSyntaxRootAsync(CancellationToken) a para capturar el nodo raíz, que analizará el documento si es necesario.

(Heredado de Document)
TryGetSyntaxTree(SyntaxTree)

Obtenga el árbol de sintaxis actual del documento si el texto ya está cargado y el árbol ya está analizado. En casi todos los casos, debe llamar GetSyntaxTreeAsync(CancellationToken) a para capturar el árbol, que analizará el árbol si aún no se ha analizado.

(Heredado de Document)
TryGetSyntaxVersion(VersionStamp)

Obtenga la versión actual del árbol de sintaxis del documento si el texto ya está cargado y el árbol ya está analizado. En casi todos los casos, debe llamar GetSyntaxVersionAsync(CancellationToken) a para capturar la versión, que cargará el árbol si aún no está disponible.

(Heredado de Document)
TryGetText(SourceText)

Obtenga el texto actual del documento si ya está cargado y disponible.

(Heredado de TextDocument)
TryGetTextVersion(VersionStamp)

Obtiene la versión del texto del documento si ya está cargada y disponible.

(Heredado de TextDocument)
WithFilePath(String)

Crea una nueva instancia de este documento actualizada para que la ruta de acceso del archivo especificada.

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

Crea una nueva instancia de este documento actualizada para tener las carpetas especificadas.

(Heredado de Document)
WithName(String)

Crea una nueva instancia de este documento actualizada para que tenga el nombre especificado.

(Heredado de Document)
WithSourceCodeKind(SourceCodeKind)

Crea una nueva instancia de este documento actualizada para que se especifique el tipo de código fuente.

(Heredado de Document)
WithSyntaxRoot(SyntaxNode)

Crea una nueva instancia de este documento actualizada para tener un árbol de sintaxis enraizado por el nodo de sintaxis especificado.

(Heredado de Document)
WithText(SourceText)

Crea una nueva instancia de este documento actualizada para que se especifique el texto.

(Heredado de Document)

Se aplica a