RunningDocumentTable Kelas
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Menyediakan akses ke tabel dokumen yang sedang berjalan (RDT) yang melacak semua dokumen yang saat ini dibuka di Visual Studio.
public ref class RunningDocumentTable : System::Collections::Generic::IEnumerable<Microsoft::VisualStudio::Shell::RunningDocumentInfo>
public class RunningDocumentTable : System.Collections.Generic.IEnumerable<Microsoft.VisualStudio.Shell.RunningDocumentInfo>
type RunningDocumentTable = class
interface seq<RunningDocumentInfo>
interface IEnumerable
Public Class RunningDocumentTable
Implements IEnumerable(Of RunningDocumentInfo)
- Warisan
-
RunningDocumentTable
- Penerapan
Contoh
Contoh ini menunjukkan cara menggunakan kelas ini dari layanan bahasa untuk mendapatkan proyek pemilik file yang saat ini terbuka di editor.
using Microsoft.VisualStudio.Package;
namespace MyLanguagePackage
{
public class MyLanguageService : LanguageService
{
IServiceProvider serviceProvider;
public IVsHierarchy GetOwningProject(Source src)
{
RunningDocumentTable rdt = new RunningDocumentTable(this.serviceProvider);
string filename = src.GetFilePath();
return rdt.GetHierarchyItem(filename);
}
}
}
Keterangan
Tabel dokumen yang sedang berjalan digunakan untuk melacak semua dokumen yang saat ini dibuka di Visual Studio, baik terlihat maupun tidak. VSPackage (lihat VSPackages) dapat mengakses RDT dengan memanggil IServiceProvider.QueryService metode pada penyedia layanan dengan ID SVsRunningDocumentTable layanan layanan dan GUID IVsRunningDocumentTable antarmuka.
Kelas ini menyederhanakan akses ke RDT untuk VSPackages dengan menyembunyikan detail IVsRunningDocumentTable antarmuka di balik kumpulan metode yang berguna. Perhatikan bahwa <xref:Microsoft.VisualStudio.Package.RunningDocumentTable> kelas hanya digunakan untuk mengakses informasi dokumen. Jika Anda ingin melacak peristiwa RDT, Anda harus mendapatkan IVsRunningDocumentTable antarmuka sendiri (melalui IServiceProvider.QueryService metode pada penyedia layanan) dan memanggil AdviseRunningDocTableEvents metode dengan implementasi IVsRunningDocTableEvents antarmuka Anda sendiri (atau turunannya).
Kelas Source menggunakan kelas ini untuk mendapatkan proyek pemilik dokumen saat membuat daftar item tugas kesalahan untuk jendela tugas.
Catatan Bagi Pemanggil
Buat instans kelas ini untuk mendapatkan informasi tentang dokumen terbuka. Objek yang dihasilkan biasanya di-cache untuk meningkatkan performa. Perhatikan bahwa kelas ini tidak menyediakan akses lengkap ke RDT.
Konstruktor
RunningDocumentTable() |
Membuat instans baru Dari RunningDocumentTable. |
RunningDocumentTable(IServiceProvider) |
Menginisialisasi instans baru kelas Microsoft.VisualStudio.Package.RunningDocumentTable. |
RunningDocumentTable(IVsRunningDocumentTable) |
Menyediakan akses ke tabel dokumen yang sedang berjalan (RDT) yang melacak semua dokumen yang saat ini dibuka di Visual Studio. |
Metode
Advise(IVsRunningDocTableEvents) |
Memungkinkan klien menerima peristiwa tentang perubahan pada Tabel Dokumen Berjalan (RDT). |
CloseDocument(__FRAMECLOSE, UInt32) |
Menutup dokumen. |
CloseHierarchy(__FRAMECLOSE, IVsHierarchy) |
Menutup hierarki proyek. |
CloseSolution(__FRAMECLOSE) |
Menutup solusi. |
FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32) |
Menemukan dan mengunci dokumen. |
FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32, IVsHierarchy, UInt32, UInt32) |
Menemukan dan mengunci dokumen. |
FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32, UInt32) |
Menemukan dan mengunci dokumen. |
FindDocument(String) |
Mendapatkan objek dari Tabel Dokumen Berjalan (RDT) yang mewakili dokumen yang ditentukan oleh jalur yang diberikan. |
FindDocument(String, IVsHierarchy, UInt32, UInt32) |
Mendapatkan objek, cookie, dan jenis proyek pemilik dari Tabel Dokumen Berjalan (RDT) untuk dokumen yang ditentukan oleh jalur yang diberikan. |
FindDocument(String, UInt32) |
Mendapatkan cookie dari Tabel Dokumen Berjalan (RDT) yang mewakili dokumen yang ditentukan oleh jalur yang diberikan. |
FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object) |
Menyediakan akses ke tabel dokumen yang sedang berjalan (RDT) yang melacak semua dokumen yang saat ini dibuka di Visual Studio. |
FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object, IVsHierarchy, UInt32, UInt32) |
Menyediakan akses ke tabel dokumen yang sedang berjalan (RDT) yang melacak semua dokumen yang saat ini dibuka di Visual Studio. |
FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object, UInt32) |
Menyediakan akses ke tabel dokumen yang sedang berjalan (RDT) yang melacak semua dokumen yang saat ini dibuka di Visual Studio. |
GetDocumentInfo(String) |
Mendapatkan informasi tentang dokumen yang terdaftar dalam Tabel Dokumen Berjalan, mengingat pengidentifikasi dokumen. |
GetDocumentInfo(UInt32) |
Mendapatkan informasi tentang dokumen yang terdaftar dalam Tabel Dokumen Berjalan, mengingat pengidentifikasi dokumen. |
GetDocumentInfoAsync(String, CancellationToken) |
Menyediakan akses ke tabel dokumen yang sedang berjalan (RDT) yang melacak semua dokumen yang saat ini dibuka di Visual Studio. |
GetDocumentInfoAsync(UInt32, CancellationToken) |
Menyediakan akses ke tabel dokumen yang sedang berjalan (RDT) yang melacak semua dokumen yang saat ini dibuka di Visual Studio. |
GetEnumerator() |
Mendapatkan enumerator dokumen dalam Tabel Dokumen yang Sedang Berjalan. |
GetHierarchyItem(String) |
Mendapatkan proyek yang memiliki dokumen yang ditentukan. |
GetRelatedSaveTreeItems(UInt32, UInt32) |
Mendapatkan array simpan item pohon. |
GetRunningDocumentContents(String) |
Menggunakan Tabel Dokumen Berjalan (RDT) untuk mendapatkan konten dokumen yang diberikan jalur ke dokumen. |
GetRunningDocumentContents(UInt32) |
Menggunakan Tabel Dokumen Berjalan (RDT) untuk mendapatkan konten dokumen yang diberikan jalur ke dokumen. |
LockDocument(_VSRDTFLAGS, UInt32) |
Mendapatkan kunci baca atau edit pada dokumen yang ditentukan. |
QueryCloseRunningDocument(String) |
Menentukan apakah dokumen dapat ditutup. |
RegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, IntPtr) |
Membuat entri dalam tabel dokumen yang sedang berjalan saat dokumen dibuat atau dibuka. |
RenameDocument(String, String, IVsHierarchy, UInt32) |
Mengganti nama dokumen dan secara opsional memberikan kepemilikan dokumen ke proyek yang ditentukan. |
SaveFileIfDirty(String) |
Menyimpan file yang ditentukan jika telah berubah sejak penyimpanan terakhir. |
Unadvise(UInt32) |
Menunjukkan klien tidak lagi tertarik untuk menerima peristiwa Running Document Table (RDT). |
UnlockDocument(_VSRDTFLAGS, UInt32) |
Melepaskan kunci baca atau edit pada dokumen yang terbuka. |
Implementasi Antarmuka Eksplisit
IEnumerable.GetEnumerator() |
Menghitung dokumen dalam Tabel Dokumen yang Sedang Berjalan. |
Metode Ekstensi
EmptyIfNull<T>(IEnumerable<T>) |
Kembalikan enumerasi ini jika tidak null. Jika null mengembalikan enumerasi kosong. |