Bagikan melalui


SourceGeneratedDocument Kelas

Definisi

Document yang dihasilkan oleh ISourceGenerator.

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

Properti

FilePath

Jalur ke file dokumen atau null jika tidak ada file dokumen.

(Diperoleh dari TextDocument)
Folders

Urutan folder logis tempat dokumen berada.

(Diperoleh dari TextDocument)
HintName

Document yang dihasilkan oleh ISourceGenerator.

Id

Pengidentifikasi dokumen. Banyak instans dokumen dapat berbagi ID yang sama, tetapi hanya satu dokumen dalam solusi yang mungkin memiliki ID tersebut.

(Diperoleh dari TextDocument)
Name

Nama dokumen.

(Diperoleh dari TextDocument)
Project

Proyek tempat dokumen ini berada.

(Diperoleh dari TextDocument)
SourceCodeKind

Jenis kode sumber yang dikandung dokumen ini.

(Diperoleh dari Document)
SupportsSemanticModel

true jika Dokumen ini mendukung penyediaan data melalui GetSemanticModelAsync(CancellationToken) metode .

Jika false kemudian metode tersebut akan kembali null sebagai gantinya.

(Diperoleh dari Document)
SupportsSyntaxTree

true jika Dokumen ini mendukung penyediaan data melalui GetSyntaxTreeAsync(CancellationToken) metode dan GetSyntaxRootAsync(CancellationToken) .

Jika false kemudian metode ini akan kembali null sebagai gantinya.

(Diperoleh dari Document)

Metode

GetLinkedDocumentIds()

Mendapatkan daftar DocumentIds yang ditautkan ke ini Document. Documents dianggap ditautkan jika mereka berbagi yang sama FilePath. Ini DocumentId dikecualikan dari hasilnya.

(Diperoleh dari Document)
GetOptionsAsync(CancellationToken)

Mengembalikan opsi yang harus diterapkan ke dokumen ini. Ini terdiri dari opsi global dari Options, digabungkan dengan pengaturan apa pun yang telah ditentukan pengguna di tingkat dokumen.

(Diperoleh dari Document)
GetSemanticModelAsync(CancellationToken)

Mendapatkan model semantik untuk dokumen ini secara asinkron.

(Diperoleh dari Document)
GetSyntaxRootAsync(CancellationToken)

Mendapatkan simpul akar pohon sintaksis secara asinkron.

(Diperoleh dari Document)
GetSyntaxTreeAsync(CancellationToken)

SyntaxTree Mendapatkan untuk dokumen ini secara asinkron.

(Diperoleh dari Document)
GetSyntaxVersionAsync(CancellationToken)

Mendapatkan versi pohon sintaksis. Ini umumnya merupakan versi teks yang lebih baru dan versi proyek.

(Diperoleh dari Document)
GetTextAsync(CancellationToken)

Mendapatkan teks saat ini untuk dokumen secara asinkron.

(Diperoleh dari TextDocument)
GetTextChangesAsync(Document, CancellationToken)

Dapatkan perubahan teks antara dokumen ini dan versi sebelumnya dari dokumen yang sama. Perubahan, ketika diterapkan ke teks dokumen lama, akan menghasilkan teks dokumen saat ini.

(Diperoleh dari Document)
GetTextVersionAsync(CancellationToken)

Mendapatkan versi teks dokumen.

(Diperoleh dari TextDocument)
TryGetSemanticModel(SemanticModel)

Mendapatkan model semantik saat ini untuk dokumen ini jika model sudah dihitung dan masih di-cache. Dalam hampir semua kasus, Anda harus memanggil GetSemanticModelAsync(CancellationToken), yang akan menghitung model semantik jika perlu.

(Diperoleh dari Document)
TryGetSyntaxRoot(SyntaxNode)

Mendapatkan simpul akar dari pohon sintaks saat ini jika pohon sintaksis telah diurai dan pohon masih di-cache. Dalam hampir semua kasus, Anda harus memanggil GetSyntaxRootAsync(CancellationToken) untuk mengambil simpul akar, yang akan mengurai dokumen jika perlu.

(Diperoleh dari Document)
TryGetSyntaxTree(SyntaxTree)

Dapatkan pohon sintaks saat ini untuk dokumen jika teks sudah dimuat dan pohon sudah diurai. Dalam hampir semua kasus, Anda harus memanggil GetSyntaxTreeAsync(CancellationToken) untuk mengambil pohon, yang akan mengurai pohon jika belum diurai.

(Diperoleh dari Document)
TryGetSyntaxVersion(VersionStamp)

Dapatkan versi pohon sintaks saat ini untuk dokumen jika teks sudah dimuat dan pohon sudah diurai. Dalam hampir semua kasus, Anda harus memanggil GetSyntaxVersionAsync(CancellationToken) untuk mengambil versi, yang akan memuat pohon jika belum tersedia.

(Diperoleh dari Document)
TryGetText(SourceText)

Dapatkan teks saat ini untuk dokumen jika sudah dimuat dan tersedia.

(Diperoleh dari TextDocument)
TryGetTextVersion(VersionStamp)

Mendapatkan versi teks dokumen jika sudah dimuat dan tersedia.

(Diperoleh dari TextDocument)
WithFilePath(String)

Membuat contoh baru dokumen ini diperbarui agar memiliki jalur file yang ditentukan.

(Diperoleh dari Document)
WithFolders(IEnumerable<String>)

Membuat contoh baru dokumen ini diperbarui agar folder yang ditentukan.

(Diperoleh dari Document)
WithName(String)

Membuat contoh baru dokumen ini diperbarui agar memiliki nama yang ditentukan.

(Diperoleh dari Document)
WithSourceCodeKind(SourceCodeKind)

Membuat contoh baru dokumen ini diperbarui agar jenis kode sumber ditentukan.

(Diperoleh dari Document)
WithSyntaxRoot(SyntaxNode)

Membuat contoh baru dokumen ini diperbarui agar memiliki pohon sintaks yang berakar dari simpul sintaks yang ditentukan.

(Diperoleh dari Document)
WithText(SourceText)

Membuat contoh baru dokumen ini diperbarui agar teks ditentukan.

(Diperoleh dari Document)

Berlaku untuk