SourceGeneratedDocument Klasse

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Paket:

Microsoft.CodeAnalysis.Workspaces.Common v4.12.0

Quelle:

SourceGeneratedDocument.cs

Ein Document von einem ISourceGenerator.

public sealed class SourceGeneratedDocument : Microsoft.CodeAnalysis.Document

type SourceGeneratedDocument = class
    inherit Document

Public NotInheritable Class SourceGeneratedDocument
Inherits Document

Vererbung

Object

TextDocument

Document

SourceGeneratedDocument

Eigenschaften

FilePath	Der Pfad zur Dokumentdatei oder null, wenn keine Dokumentdatei vorhanden ist. (Geerbt von TextDocument)
Folders	Die Sequenz der logischen Ordner, in der das Dokument enthalten ist. (Geerbt von TextDocument)
HintName	Ein Document von einem ISourceGenerator.
Id	Der Bezeichner des Dokuments. Viele Dokumentinstanzen können dieselbe ID freigeben, aber nur ein Dokument in einer Lösung hat möglicherweise diese ID. (Geerbt von TextDocument)
Name	Der Name des Dokuments. (Geerbt von TextDocument)
Project	Das Projekt, zu dem dieses Dokument gehört. (Geerbt von TextDocument)
SourceCodeKind	Die Art des Quellcodes dieses Dokuments enthält. (Geerbt von Document)
SupportsSemanticModel	true wenn dieses Dokument die Bereitstellung von Daten über die GetSemanticModelAsync(CancellationToken) Methode unterstützt. Wenn false diese Methode stattdessen zurückgegeben wird null . (Geerbt von Document)
SupportsSyntaxTree	true wenn dieses Dokument die Bereitstellung von Daten über die GetSyntaxTreeAsync(CancellationToken) methoden unterstützt GetSyntaxRootAsync(CancellationToken) . Wenn false diese Methoden stattdessen zurückgegeben null werden. (Geerbt von Document)

Methoden

GetLinkedDocumentIds()	Ruft die Liste von DocumentIdS ab, die mit diesem Documentverknüpft sind. Documents werden als verknüpft betrachtet, wenn sie dieselbe FilePathteilen. Dies DocumentId ist aus dem Ergebnis ausgeschlossen. (Geerbt von Document)
GetOptionsAsync(CancellationToken)	Gibt die Optionen zurück, die auf dieses Dokument angewendet werden sollen. Dies besteht aus globalen Optionen aus Options, zusammengeführt mit allen Einstellungen, die der Benutzer auf Dokumentebene angegeben hat. (Geerbt von Document)
GetSemanticModelAsync(CancellationToken)	Ruft das semantische Modell für dieses Dokument asynchron ab. (Geerbt von Document)
GetSyntaxRootAsync(CancellationToken)	Ruft den Stammknoten der Syntaxstruktur asynchron ab. (Geerbt von Document)
GetSyntaxTreeAsync(CancellationToken)	Ruft das SyntaxTree für dieses Dokument asynchron ab. (Geerbt von Document)
GetSyntaxVersionAsync(CancellationToken)	Ruft die Version der Syntaxstruktur ab. Dies ist im Allgemeinen der neuere Textversion und die Version des Projekts. (Geerbt von Document)
GetTextAsync(CancellationToken)	Ruft den aktuellen Text für das Dokument asynchron ab. (Geerbt von TextDocument)
GetTextChangesAsync(Document, CancellationToken)	Rufen Sie die Textänderungen zwischen diesem Dokument und einer früheren Version desselben Dokuments ab. Die Änderungen, wenn sie auf den Text des alten Dokuments angewendet werden, erzeugen den Text des aktuellen Dokuments. (Geerbt von Document)
GetTextVersionAsync(CancellationToken)	Ruft die Version des Texts des Dokuments ab. (Geerbt von TextDocument)
TryGetSemanticModel(SemanticModel)	Ruft das aktuelle semantische Modell für dieses Dokument ab, wenn das Modell bereits berechnet und weiterhin zwischengespeichert wird. In fast allen Fällen sollten Sie aufrufen, was das semantische Modell bei GetSemanticModelAsync(CancellationToken)Bedarf berechnet. (Geerbt von Document)
TryGetSyntaxRoot(SyntaxNode)	Ruft den Stammknoten der aktuellen Syntaxstruktur ab, wenn die Syntaxstruktur bereits analysiert wurde und die Struktur weiterhin zwischengespeichert wird. In fast allen Fällen sollten GetSyntaxRootAsync(CancellationToken) Sie aufrufen, um den Stammknoten abzurufen, der das Dokument bei Bedarf analysiert. (Geerbt von Document)
TryGetSyntaxTree(SyntaxTree)	Rufen Sie die aktuelle Syntaxstruktur für das Dokument ab, wenn der Text bereits geladen wird und die Struktur bereits analysiert wird. In fast allen Fällen sollten GetSyntaxTreeAsync(CancellationToken) Sie die Struktur abrufen, die die Struktur analysiert, wenn sie noch nicht analysiert wird. (Geerbt von Document)
TryGetSyntaxVersion(VersionStamp)	Rufen Sie die aktuelle Syntaxstrukturversion für das Dokument ab, wenn der Text bereits geladen wird und die Struktur bereits analysiert wird. In fast allen Fällen sollten GetSyntaxVersionAsync(CancellationToken) Sie aufrufen, um die Version abzurufen, die die Struktur lädt, wenn sie noch nicht verfügbar ist. (Geerbt von Document)
TryGetText(SourceText)	Rufen Sie den aktuellen Text für das Dokument ab, wenn sie bereits geladen und verfügbar ist. (Geerbt von TextDocument)
TryGetTextVersion(VersionStamp)	Ruft die Version des Texts des Dokuments ab, wenn es bereits geladen und verfügbar ist. (Geerbt von TextDocument)
WithFilePath(String)	Erstellt eine neue Instanz dieses Dokuments, um den angegebenen Dateipfad zu erhalten. (Geerbt von Document)
WithFolders(IEnumerable<String>)	Erstellt eine neue Instanz dieses Dokuments, um die angegebenen Ordner zu erhalten. (Geerbt von Document)
WithName(String)	Erstellt eine neue Instanz dieses Dokuments, um den angegebenen Namen zu erhalten. (Geerbt von Document)
WithSourceCodeKind(SourceCodeKind)	Erstellt eine neue Instanz dieses Dokuments, um die Quellcodeart angegeben zu haben. (Geerbt von Document)
WithSyntaxRoot(SyntaxNode)	Erstellt eine neue Instanz dieses Dokuments, um eine Syntaxstruktur mit dem angegebenen Syntaxknoten zu enthalten. (Geerbt von Document)
WithText(SourceText)	Erstellt eine neue Instanz dieses Dokuments, um den text angegeben zu haben. (Geerbt von Document)