RunningDocumentTable Klasa

Odwołanie

Definicja

Przestrzeń nazw:: Microsoft.VisualStudio.Shell

Zestaw:: Microsoft.VisualStudio.Shell.14.0.dll

Zestaw:: Microsoft.VisualStudio.Shell.15.0.dll

Pakiet:: Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Zapewnia dostęp do uruchomionej tabeli dokumentów (RDT), która śledzi wszystkie aktualnie otwarte dokumenty w programie 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)

Dziedziczenie: Object
RunningDocumentTable

Implementuje: IEnumerable<RunningDocumentInfo> IEnumerable

Przykłady

W tym przykładzie pokazano, jak używać tej klasy z usługi językowej w celu uzyskania projektu posiadania pliku aktualnie otwartego w edytorze.

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);  
        }  
    }  
}

Uwagi

Uruchomiona tabela dokumentów służy do śledzenia wszystkich dokumentów, które są obecnie otwierane w programie Visual Studio, niezależnie od tego, czy są one widoczne, czy nie. Pakiet VSPackage (zobacz VSPackages) może uzyskać dostęp do RDT, wywołując IServiceProvider.QueryService metodę dostawcy usług z identyfikatorem SVsRunningDocumentTable usługi usługi i identyfikatorem GUID interfejsu IVsRunningDocumentTable .

Ta klasa upraszcza dostęp do RDT dla pakietów VSPackage, ukrywając szczegóły interfejsu IVsRunningDocumentTable za kolekcją przydatnych metod. Należy pamiętać, że <xref:Microsoft.VisualStudio.Package.RunningDocumentTable> klasa jest używana tylko do uzyskiwania dostępu do informacji o dokumencie. Jeśli chcesz śledzić zdarzenia RDT, musisz samodzielnie uzyskać IVsRunningDocumentTable interfejs (za pośrednictwem IServiceProvider.QueryService metody u dostawcy usług) i wywołać AdviseRunningDocTableEvents metodę z własną implementacją interfejsu IVsRunningDocTableEvents (lub jego pochodnych).

Klasa Source używa tej klasy do uzyskania projektu będącego właścicielem dokumentu podczas kompilowania listy elementów zadań błędów dla okien zadań.

Uwagi dotyczące wywoływania

Utwórz wystąpienie tej klasy, aby uzyskać informacje o otwartym dokumencie. Wynikowy obiekt jest zwykle buforowany w celu zwiększenia wydajności. Należy pamiętać, że ta klasa nie zapewnia pełnego dostępu do RDT.

Konstruktory

RunningDocumentTable()	Tworzy wystąpienie nowej tabeli RunningDocumentTable.
RunningDocumentTable(IServiceProvider)	Inicjuje nowe wystąpienie klasy Microsoft.VisualStudio.Package.RunningDocumentTable.
RunningDocumentTable(IVsRunningDocumentTable)	Zapewnia dostęp do uruchomionej tabeli dokumentów (RDT), która śledzi wszystkie aktualnie otwarte dokumenty w programie Visual Studio.

Metody

Advise(IVsRunningDocTableEvents)	Umożliwia klientowi odbieranie zdarzeń dotyczących zmian w tabeli uruchomionych dokumentów (RDT).
CloseDocument(__FRAMECLOSE, UInt32)	Zamyka dokument.
CloseHierarchy(__FRAMECLOSE, IVsHierarchy)	Zamyka hierarchię projektu.
CloseSolution(__FRAMECLOSE)	Zamyka rozwiązanie.
FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32)	Znajduje i blokuje dokument.
FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32, IVsHierarchy, UInt32, UInt32)	Znajduje i blokuje dokument.
FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32, UInt32)	Znajduje i blokuje dokument.
FindDocument(String)	Pobiera obiekt z tabeli uruchomionego dokumentu (RDT), który reprezentuje dokument określony przez daną ścieżkę.
FindDocument(String, IVsHierarchy, UInt32, UInt32)	Pobiera obiekt, plik cookie i typ projektu będącą właścicielem z tabeli uruchomionych dokumentów (RDT) dla dokumentu określonego przez daną ścieżkę.
FindDocument(String, UInt32)	Pobiera plik cookie z tabeli uruchomionego dokumentu (RDT), który reprezentuje dokument określony przez daną ścieżkę.
FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object)	Zapewnia dostęp do uruchomionej tabeli dokumentów (RDT), która śledzi wszystkie aktualnie otwarte dokumenty w programie Visual Studio.
FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object, IVsHierarchy, UInt32, UInt32)	Zapewnia dostęp do uruchomionej tabeli dokumentów (RDT), która śledzi wszystkie aktualnie otwarte dokumenty w programie Visual Studio.
FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object, UInt32)	Zapewnia dostęp do uruchomionej tabeli dokumentów (RDT), która śledzi wszystkie aktualnie otwarte dokumenty w programie Visual Studio.
GetDocumentInfo(String)	Pobiera informacje o dokumencie zarejestrowanym w tabeli uruchomionych dokumentów, biorąc pod uwagę identyfikator dokumentu.
GetDocumentInfo(UInt32)	Pobiera informacje o dokumencie zarejestrowanym w tabeli uruchomionych dokumentów, biorąc pod uwagę identyfikator dokumentu.
GetDocumentInfoAsync(String, CancellationToken)	Zapewnia dostęp do uruchomionej tabeli dokumentów (RDT), która śledzi wszystkie aktualnie otwarte dokumenty w programie Visual Studio.
GetDocumentInfoAsync(UInt32, CancellationToken)	Zapewnia dostęp do uruchomionej tabeli dokumentów (RDT), która śledzi wszystkie aktualnie otwarte dokumenty w programie Visual Studio.
GetEnumerator()	Pobiera moduł wyliczający dokumentów w tabeli Uruchomiony dokument.
GetHierarchyItem(String)	Pobiera projekt, który jest właścicielem określonego dokumentu.
GetRelatedSaveTreeItems(UInt32, UInt32)	Pobiera tablicę zapisywania elementów drzewa.
GetRunningDocumentContents(String)	Używa tabeli uruchomionych dokumentów (RDT) do uzyskania zawartości dokumentu podanej w ścieżce do dokumentu.
GetRunningDocumentContents(UInt32)	Używa tabeli uruchomionych dokumentów (RDT) do uzyskania zawartości dokumentu podanej w ścieżce do dokumentu.
LockDocument(_VSRDTFLAGS, UInt32)	Pobiera blokadę odczytu lub edycji określonego dokumentu.
QueryCloseRunningDocument(String)	Określa, czy dokument można zamknąć.
RegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, IntPtr)	Tworzy wpis w uruchomionej tabeli dokumentów po utworzeniu lub otwarciu dokumentu.
RenameDocument(String, String, IVsHierarchy, UInt32)	Zmienia nazwę dokumentu i opcjonalnie nadaje własność dokumentu określonemu projektowi.
SaveFileIfDirty(String)	Zapisuje określony plik, jeśli został zmieniony od ostatniego zapisu.
Unadvise(UInt32)	Wskazuje, że klient nie jest już zainteresowany otrzymywaniem zdarzeń uruchomionej tabeli dokumentów (RDT).
UnlockDocument(_VSRDTFLAGS, UInt32)	Zwalnia blokadę odczytu lub edycji otwartego dokumentu.

Jawne implementacje interfejsu

IEnumerable.GetEnumerator()

Wylicza dokumenty w tabeli Uruchomiony dokument.

Metody rozszerzania

EmptyIfNull<T>(IEnumerable<T>)

Zwróć to wyliczenie, jeśli nie ma wartości null. W przypadku, gdy jest zwracana wartość null, zwracana jest pusta wyliczenie.

Dotyczy

Udostępnij za pośrednictwem