Condividi tramite

Classe RunningDocumentTable

  • Articolo

Consente di accedere alla tabella in esecuzione il documento (RDT) che tiene traccia di tutti i documenti aperti in Visual Studio.

Gerarchia di ereditarietà

System.Object
  Microsoft.VisualStudio.Shell.RunningDocumentTable

Spazio dei nomi:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Sintassi

'Dichiarazione
Public Class RunningDocumentTable _
    Implements IEnumerable(Of RunningDocumentInfo), IEnumerable

public class RunningDocumentTable : IEnumerable<RunningDocumentInfo>, 
    IEnumerable

Il tipo RunningDocumentTable espone i seguenti membri.

Costruttori

  Nome Descrizione
Metodo pubblico RunningDocumentTable()
Metodo pubblico RunningDocumentTable(IServiceProvider) Inizializza una nuova istanza della classe di RunningDocumentTable .

In alto

Metodi

  Nome Descrizione
Metodo pubblico Advise Consente al client per ricevere eventi sulle modifiche apportate alla Tabella (RDT) in esecuzione il documento.
Metodo pubblico CloseDocument
Metodo pubblico CloseHierarchy
Metodo pubblico CloseSolution
Metodo pubblico Equals Determina se l'oggetto specificato equivale all'oggetto corrente. (Ereditato da Object)
Metodo protetto Finalize Consente a un oggetto di provare a liberare risorse ed eseguire altre operazioni di pulitura prima che l'oggetto stesso venga recuperato dalla procedura di Garbage Collection. (Ereditato da Object)
Metodo pubblico FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32)
Metodo pubblico FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32, UInt32%)
Metodo pubblico FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32, IVsHierarchy%, UInt32%, UInt32%)
Metodo pubblico FindDocument(String) Ottiene un oggetto dalla Tabella (RDT) in esecuzione il documento che rappresenta il documento specificato dal percorso specificato.
Metodo pubblico FindDocument(String, UInt32%) Ottiene un cookie dalla Tabella in esecuzione il (RDT) documento che rappresenta il documento specificato dal percorso specificato.
Metodo pubblico FindDocument(String, IVsHierarchy%, UInt32%, UInt32%) Ottiene un oggetto, i cookie e un tipo di progetto proprietario della Tabella in esecuzione di (RDT) documento per il documento specificato dal percorso specificato.
Metodo pubblico FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object)
Metodo pubblico FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object, UInt32%)
Metodo pubblico FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object, IVsHierarchy%, UInt32%, UInt32%)
Metodo pubblico GetDocumentInfo Ottiene le informazioni su un documento registrato nella Tabella in esecuzione il documento, verrà visualizzato l'identificatore del documento.
Metodo pubblico GetEnumerator Ottiene un enumeratore dei documenti nella Tabella in esecuzione il documento.
Metodo pubblico GetHashCode Funge da funzione hash per un determinato tipo. (Ereditato da Object)
Metodo pubblico GetHierarchyItem Ottiene il progetto a cui appartiene il documento specificato.
Metodo pubblico GetRelatedSaveTreeItems
Metodo pubblico GetRunningDocumentContents(String) Viene utilizzata la Tabella in esecuzione di (RDT) documento per ottenere il contenuto di un documento specificato il percorso del documento.
Metodo pubblico GetRunningDocumentContents(UInt32) Viene utilizzata la Tabella in esecuzione di (RDT) documento per ottenere il contenuto di un documento specificato il percorso del documento.
Metodo pubblico GetType Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
Metodo pubblico LockDocument Ottiene letti o la modifica del documento specificato.
Metodo protetto MemberwiseClone Consente di creare una copia dei riferimenti dell'oggetto Object corrente. (Ereditato da Object)
Metodo pubblico QueryCloseRunningDocument
Metodo pubblico RegisterAndLockDocument Crea una voce della tabella in esecuzione il documento quando viene creato o aperto un documento.
Metodo pubblico RenameDocument Rinomina un documento e facoltativamente fornisce la proprietà del progetto specificato.
Metodo pubblico SaveFileIfDirty Salvare il file specificato se ha modificato dagli ultimi salvataggio.
Metodo pubblico ToString Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)
Metodo pubblico Unadvise Indica che il client si è interessati a ricevere gli eventi in esecuzione la Tabella (RDT) del documento.
Metodo pubblico UnlockDocument Rilascia letti o la modifica imposta il documento aperto.

In alto

Implementazioni esplicite dell'interfaccia

  Nome Descrizione
Implementazione esplicita dell'interfacciaMetodo privato IEnumerable.GetEnumerator Enumera i documenti nella Tabella in esecuzione il documento.

In alto

Note

La tabella in esecuzione il documento viene utilizzata per tenere traccia di tutti i documenti attualmente aperti in Visual Studio, se sono visibili o meno.Un VSPackage (vedere Vspackage) può accedere al RDT chiamando il metodo di IServiceProvider.QueryService su un provider di servizi tramite il servizio ID del servizio di SVsRunningDocumentTablee il GUID dell'interfaccia di IVsRunningDocumentTable .

Questa classe semplifica l'accesso al RDT per Vspackage nascondendo i dettagli dell'interfaccia di IVsRunningDocumentTable dietro una raccolta di metodi utili.Si noti che la classe di RunningDocumentTable viene utilizzata solo per accedere alle informazioni del documento.Se si desidera tenere traccia degli eventi di RDT, è necessario ottenere l'interfaccia di IVsRunningDocumentTable manualmente tramite il metodo di IServiceProvider.QueryService su un provider di servizi) e chiamare il metodo di AdviseRunningDocTableEvents con diventi proprietaria l'implementazione dell'interfaccia di IVsRunningDocTableEvents (o delle classi derivate).

La classe di Source utilizza questa classe per ottenere il progetto proprietario di un documento quando si compila l'elenco degli elementi attività di errori per le finestre di attività.

Note per i chiamanti

Creare un'istanza di questa classe per ottenere informazioni su un documento aperto.L'oggetto risultante in genere viene memorizzata nella cache per migliorare le prestazioni.Si noti che la classe non fornisce l'accesso completo a RDT.

Esempi

In questo esempio viene illustrato come utilizzare questa classe da un servizio di linguaggio per ottenere attualmente il progetto proprietario di un file aperto nell'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);
        }
    }
}

Codice thread safe

Qualsiasi membro static (Shared in Visual Basic) pubblico di questo tipo è thread-safe. I membri di istanza non sono garantiti come thread-safe.

Vedere anche

Riferimenti

Spazio dei nomi Microsoft.VisualStudio.Shell