Document Clase

Definición

Espacio de nombres:

Microsoft.CodeAnalysis

Ensamblado:

Microsoft.CodeAnalysis.Workspaces.dll

Paquete:

Microsoft.CodeAnalysis.Workspaces.Common v4.13.0

Source:

Document.cs

Representa un documento de código fuente que forma parte de un proyecto. Proporciona acceso al texto de origen, al árbol de sintaxis analizado y al modelo semántico correspondiente.

C#

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

Herencia

Object

TextDocument

Document

Derivado

Microsoft.CodeAnalysis.SourceGeneratedDocument

Atributos

DebuggerDisplayAttribute

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)
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.
SupportsSemanticModel	true si este documento admite proporcionar datos a través del GetSemanticModelAsync(CancellationToken) método . Si false ese método devolverá null en su lugar.
SupportsSyntaxTree	true si este documento admite proporcionar 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 .

Métodos

GetLinkedDocumentIds()	Obtiene la lista de DocumentIds que están vinculadas a este Documentobjeto . Documentse consideran vinculados si comparten el mismo FilePath. Esto DocumentId se excluye del resultado.
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.
GetSemanticModelAsync(CancellationToken)	Obtiene el modelo semántico de este documento de forma asincrónica.
GetSyntaxRootAsync(CancellationToken)	Obtiene el nodo raíz del árbol de sintaxis de forma asincrónica.
GetSyntaxTreeAsync(CancellationToken)	Obtiene para SyntaxTree este documento de forma asincrónica.
GetSyntaxVersionAsync(CancellationToken)	Obtiene la versión del árbol de sintaxis. Por lo general, es la más reciente de la versión de texto y la versión del proyecto.
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.
GetTextVersionAsync(CancellationToken)	Obtiene la versión del texto del documento. (Heredado de TextDocument)
TryGetSemanticModel(SemanticModel)	Obtiene el modelo semántico actual para 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.
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 se almacena 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.
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.
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.
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 tener la ruta de acceso de archivo especificada.
WithFolders(IEnumerable<String>)	Crea una nueva instancia de este documento actualizada para tener las carpetas especificadas.
WithName(String)	Crea una nueva instancia de este documento actualizada para que tenga el nombre especificado.
WithSourceCodeKind(SourceCodeKind)	Crea una nueva instancia de este documento actualizada para que se especifique el tipo de código fuente.
WithSyntaxRoot(SyntaxNode)	Crea una nueva instancia de este documento actualizada para tener un árbol de sintaxis rooteado por el nodo de sintaxis especificado.
WithText(SourceText)	Crea una nueva instancia de este documento actualizada para que se especifique el texto.

Se aplica a