Document Classe

Definizione

Spazio dei nomi:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Pacchetto:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

Document.cs

Rappresenta un documento di codice sorgente che fa parte di un progetto. Fornisce l'accesso al testo di origine, all'albero della sintassi analizzata e al modello semantico corrispondente.

public ref class Document : Microsoft::CodeAnalysis::TextDocument

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

[<System.Diagnostics.DebuggerDisplay("{GetDebuggerDisplay(),nq}")>]
type Document = class
    inherit TextDocument

Public Class Document
Inherits TextDocument

Ereditarietà

Object

TextDocument

Document

Derivato

Microsoft.CodeAnalysis.SourceGeneratedDocument

Attributi

DebuggerDisplayAttribute

Proprietà

FilePath	Percorso del file di documento o Null se non è presente alcun file di documento. (Ereditato da TextDocument)
Folders	La sequenza di cartelle logiche in cui è contenuto il documento. (Ereditato da TextDocument)
Id	Identificatore del documento. Molte istanze del documento possono condividere lo stesso ID, ma solo un documento in una soluzione può avere tale ID. (Ereditato da TextDocument)
Name	Nome del documento. (Ereditato da TextDocument)
Project	Il progetto a cui appartiene il documento. (Ereditato da TextDocument)
SourceCodeKind	Tipo di codice sorgente contenuto nel documento.
SupportsSemanticModel	true se questo documento supporta la fornitura di dati tramite il GetSemanticModelAsync(CancellationToken) metodo . Se false il metodo restituirà null invece .
SupportsSyntaxTree	true se questo documento supporta la fornitura di dati tramite i GetSyntaxTreeAsync(CancellationToken) metodi e GetSyntaxRootAsync(CancellationToken) . Se false questi metodi restituiranno null invece .

Metodi

GetLinkedDocumentIds()	Ottiene l'elenco di DocumentIdoggetti collegati all'oggetto Document. Documents viene considerato collegato se condividono lo stesso FilePathoggetto . Questo DocumentId valore viene escluso dal risultato.
GetOptionsAsync(CancellationToken)	Restituisce le opzioni da applicare al documento. Ciò è costituito da opzioni globali da Options, unite a tutte le impostazioni specificate dall'utente a livello di documento.
GetSemanticModelAsync(CancellationToken)	Ottiene il modello semantico per questo documento in modo asincrono.
GetSyntaxRootAsync(CancellationToken)	Ottiene il nodo radice dell'albero della sintassi in modo asincrono.
GetSyntaxTreeAsync(CancellationToken)	Ottiene l'oggetto SyntaxTree per questo documento in modo asincrono.
GetSyntaxVersionAsync(CancellationToken)	Ottiene la versione dell'albero della sintassi. Si tratta in genere della versione di testo più recente e della versione del progetto.
GetTextAsync(CancellationToken)	Ottiene il testo corrente per il documento in modo asincrono. (Ereditato da TextDocument)
GetTextChangesAsync(Document, CancellationToken)	Ottenere le modifiche di testo tra questo documento e una versione precedente dello stesso documento. Le modifiche, se applicate al testo del documento precedente, produrranno il testo del documento corrente.
GetTextVersionAsync(CancellationToken)	Ottiene la versione del testo del documento. (Ereditato da TextDocument)
TryGetSemanticModel(SemanticModel)	Ottiene il modello semantico corrente per questo documento se il modello è già calcolato e ancora memorizzato nella cache. In quasi tutti i casi, è necessario chiamare GetSemanticModelAsync(CancellationToken), che calcola il modello semantico, se necessario.
TryGetSyntaxRoot(SyntaxNode)	Ottiene il nodo radice dell'albero della sintassi corrente se l'albero della sintassi è già stato analizzato e l'albero è ancora memorizzato nella cache. In quasi tutti i casi, è necessario chiamare GetSyntaxRootAsync(CancellationToken) per recuperare il nodo radice, che analizzerà il documento, se necessario.
TryGetSyntaxTree(SyntaxTree)	Ottiene l'albero della sintassi corrente per il documento se il testo è già caricato e l'albero è già analizzato. In quasi tutti i casi, è necessario chiamare GetSyntaxTreeAsync(CancellationToken) per recuperare l'albero, che analizzerà l'albero se non è già analizzato.
TryGetSyntaxVersion(VersionStamp)	Ottenere la versione corrente dell'albero della sintassi per il documento se il testo è già caricato e l'albero è già analizzato. In quasi tutti i casi, è necessario chiamare GetSyntaxVersionAsync(CancellationToken) per recuperare la versione, che caricherà l'albero se non è già disponibile.
TryGetText(SourceText)	Ottiene il testo corrente per il documento, se è già caricato e disponibile. (Ereditato da TextDocument)
TryGetTextVersion(VersionStamp)	Ottiene la versione del testo del documento se è già caricata e disponibile. (Ereditato da TextDocument)
WithFilePath(String)	Crea una nuova istanza del documento aggiornata in modo da avere il percorso del file specificato.
WithFolders(IEnumerable<String>)	Crea una nuova istanza di questo documento aggiornata in modo da avere le cartelle specificate.
WithName(String)	Crea una nuova istanza del documento aggiornata in modo da avere il nome specificato.
WithSourceCodeKind(SourceCodeKind)	Crea una nuova istanza del documento aggiornata per specificare il tipo di codice sorgente.
WithSyntaxRoot(SyntaxNode)	Crea una nuova istanza di questo documento aggiornata in modo da avere un albero della sintassi rooted dal nodo della sintassi specificato.
WithText(SourceText)	Crea una nuova istanza del documento aggiornata in modo da specificare il testo.