SourceGeneratedDocument Classe

Définition

Espace de noms:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Paquet:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

SourceGeneratedDocument.cs

Qui Document a été généré par un ISourceGenerator.

public sealed class SourceGeneratedDocument : Microsoft.CodeAnalysis.Document

type SourceGeneratedDocument = class
    inherit Document

Public NotInheritable Class SourceGeneratedDocument
Inherits Document

Héritage

Object

TextDocument

Document

SourceGeneratedDocument

Propriétés

FilePath	Chemin d’accès au fichier de document ou null s’il n’existe aucun fichier de document. (Hérité de TextDocument)
Folders	La séquence de dossiers logiques dans utilisant le document est contenue. (Hérité de TextDocument)
HintName	Qui Document a été généré par un ISourceGenerator.
Id	Identificateur du document. De nombreuses instances de document peuvent partager le même ID, mais un seul document d’une solution peut avoir cet ID. (Hérité de TextDocument)
Name	Nom du document. (Hérité de TextDocument)
Project	Le projet auquel appartient ce document. (Hérité de TextDocument)
SourceCodeKind	Type de code source que contient ce document. (Hérité de Document)
SupportsSemanticModel	true si ce document prend en charge la fourniture de données via la GetSemanticModelAsync(CancellationToken) méthode. Si false cette méthode retourne null à la place. (Hérité de Document)
SupportsSyntaxTree	truesi ce document prend en charge la fourniture de données via les méthodes et GetSyntaxRootAsync(CancellationToken) les GetSyntaxTreeAsync(CancellationToken) méthodes. Si false ces méthodes retournent null à la place. (Hérité de Document)

Méthodes

GetLinkedDocumentIds()	Obtient la liste des DocumentIds qui sont liés à cet Documentobjet . Documentsont considérés comme liés s’ils partagent le même FilePath. Ceci DocumentId est exclu du résultat. (Hérité de Document)
GetOptionsAsync(CancellationToken)	Retourne les options qui doivent être appliquées à ce document. Il s’agit d’options globales à partir de Options, fusionnées avec tous les paramètres que l’utilisateur a spécifiés au niveau du document. (Hérité de Document)
GetSemanticModelAsync(CancellationToken)	Obtient le modèle sémantique de ce document de façon asynchrone. (Hérité de Document)
GetSyntaxRootAsync(CancellationToken)	Obtient le nœud racine de l’arborescence de syntaxe de manière asynchrone. (Hérité de Document)
GetSyntaxTreeAsync(CancellationToken)	Obtient le SyntaxTree document de façon asynchrone. (Hérité de Document)
GetSyntaxVersionAsync(CancellationToken)	Obtient la version de l’arborescence de syntaxe. Il s’agit généralement du plus récent de la version de texte et de la version du projet. (Hérité de Document)
GetTextAsync(CancellationToken)	Obtient le texte actuel du document de façon asynchrone. (Hérité de TextDocument)
GetTextChangesAsync(Document, CancellationToken)	Obtenez les modifications de texte entre ce document et une version antérieure du même document. Les modifications, lorsqu’elles sont appliquées au texte de l’ancien document, produisent le texte du document actif. (Hérité de Document)
GetTextVersionAsync(CancellationToken)	Obtient la version du texte du document. (Hérité de TextDocument)
TryGetSemanticModel(SemanticModel)	Obtient le modèle sémantique actuel pour ce document si le modèle est déjà calculé et toujours mis en cache. Dans presque tous les cas, vous devez appeler GetSemanticModelAsync(CancellationToken), ce qui calcule le modèle sémantique si nécessaire. (Hérité de Document)
TryGetSyntaxRoot(SyntaxNode)	Obtient le nœud racine de l’arborescence de syntaxe actuelle si l’arborescence de syntaxe a déjà été analysée et que l’arborescence est toujours mise en cache. Dans presque tous les cas, vous devez appeler GetSyntaxRootAsync(CancellationToken) pour extraire le nœud racine, ce qui analyse le document si nécessaire. (Hérité de Document)
TryGetSyntaxTree(SyntaxTree)	Obtenez l’arborescence de syntaxe actuelle du document si le texte est déjà chargé et que l’arborescence est déjà analysée. Dans presque tous les cas, vous devez appeler GetSyntaxTreeAsync(CancellationToken) pour extraire l’arborescence, ce qui analyse l’arbre s’il n’est pas déjà analysé. (Hérité de Document)
TryGetSyntaxVersion(VersionStamp)	Obtenez la version actuelle de l’arborescence de syntaxe du document si le texte est déjà chargé et que l’arborescence est déjà analysée. Dans presque tous les cas, vous devez appeler GetSyntaxVersionAsync(CancellationToken) pour récupérer la version, ce qui charge l’arborescence s’il n’est pas déjà disponible. (Hérité de Document)
TryGetText(SourceText)	Obtenez le texte actuel du document s’il est déjà chargé et disponible. (Hérité de TextDocument)
TryGetTextVersion(VersionStamp)	Obtient la version du texte du document s’il est déjà chargé et disponible. (Hérité de TextDocument)
WithFilePath(String)	Crée une instance de ce document mise à jour pour avoir le chemin d’accès de fichier spécifié. (Hérité de Document)
WithFolders(IEnumerable<String>)	Crée une instance de ce document mise à jour pour avoir les dossiers spécifiés. (Hérité de Document)
WithName(String)	Crée une instance de ce document mise à jour pour avoir le nom spécifié. (Hérité de Document)
WithSourceCodeKind(SourceCodeKind)	Crée une instance de ce document mise à jour pour que le type de code source soit spécifié. (Hérité de Document)
WithSyntaxRoot(SyntaxNode)	Crée une instance de ce document mise à jour pour avoir une arborescence de syntaxe racine par le nœud de syntaxe spécifié. (Hérité de Document)
WithText(SourceText)	Crée une instance de ce document mise à jour pour que le texte soit spécifié. (Hérité de Document)