Partager via

RunningDocumentTable, classe

  • Article

Permet d'accéder au tableau en cours d'exécution (RDT) de document qui suit tous les documents actuellement ouverts dans Visual Studio.

Hiérarchie d'héritage

System.Object
  Microsoft.VisualStudio.Shell.RunningDocumentTable

Espace de noms :  Microsoft.VisualStudio.Shell
Assembly :  Microsoft.VisualStudio.Shell.11.0 (dans Microsoft.VisualStudio.Shell.11.0.dll)

Syntaxe

'Déclaration
Public Class RunningDocumentTable _
    Implements IEnumerable(Of RunningDocumentInfo), IEnumerable

public class RunningDocumentTable : IEnumerable<RunningDocumentInfo>, 
    IEnumerable

Le type RunningDocumentTable expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique RunningDocumentTable()
Méthode publique RunningDocumentTable(IServiceProvider) Initialise une nouvelle instance de la classe RunningDocumentTable.

Début

Méthodes

  Nom Description
Méthode publique Advise Permet au client pour recevoir des événements sur des modifications à la table en cours d'exécution (RDT) de document.
Méthode publique CloseDocument
Méthode publique CloseHierarchy
Méthode publique CloseSolution
Méthode publique Equals Détermine si l'objet Object spécifié est égal à l'objet Object actuel. (Hérité de Object.)
Méthode protégée Finalize Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
Méthode publique FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32)
Méthode publique FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32, UInt32%)
Méthode publique FindAndLockDocumentEx(_VSRDTFLAGS, String, IVsHierarchy, UInt32, IVsHierarchy%, UInt32%, UInt32%)
Méthode publique FindDocument(String) Obtient un objet du Tableau en cours d'exécution (RDT) de document qui représente le document spécifié par le chemin d'accès donné.
Méthode publique FindDocument(String, UInt32%) Obtient un cookie du Tableau en cours d'exécution (RDT) de document qui représente le document spécifié par le chemin d'accès donné.
Méthode publique FindDocument(String, IVsHierarchy%, UInt32%, UInt32%) Obtient un objet, un cookie, et un type de projet propriétaire de la table en cours d'exécution (RDT) de document pour le document spécifié par le chemin d'accès donné.
Méthode publique FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object)
Méthode publique FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object, UInt32%)
Méthode publique FindOrRegisterAndLockDocument(_VSRDTFLAGS, String, IVsHierarchy, UInt32, Object, IVsHierarchy%, UInt32%, UInt32%)
Méthode publique GetDocumentInfo Obtient des informations sur un document enregistré dans le Tableau en cours d'exécution de document, en fonction de l'identificateur du document.
Méthode publique GetEnumerator Obtient un énumérateur des documents dans le Tableau en cours d'exécution de document.
Méthode publique GetHashCode Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
Méthode publique GetHierarchyItem Obtient le projet qui possède le document spécifié.
Méthode publique GetRelatedSaveTreeItems
Méthode publique GetRunningDocumentContents(String) Utilise le Tableau en cours d'exécution (RDT) de document pour obtenir le contenu d'un document donné le chemin d'accès au document.
Méthode publique GetRunningDocumentContents(UInt32) Utilise le Tableau en cours d'exécution (RDT) de document pour obtenir le contenu d'un document donné le chemin d'accès au document.
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publique LockDocument Obtient un verrou de lecture ou de modification dans le document spécifié.
Méthode protégée MemberwiseClone Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
Méthode publique QueryCloseRunningDocument
Méthode publique RegisterAndLockDocument Crée une entrée dans le tableau en cours d'exécution de document lorsqu'un document est créé ou ouvert.
Méthode publique RenameDocument Renomme un document et donne éventuellement la propriété du document au projet spécifié.
Méthode publique SaveFileIfDirty Enregistre le fichier spécifié s'il a changé depuis la dernière sauvegarde.
Méthode publique ToString Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)
Méthode publique Unadvise Indique le client n'est plus intéresse à recevoir des événements en cours d'exécution (RDT) de Tableau de document.
Méthode publique UnlockDocument Libère un verrou de lecture ou de modification dans le document ouvert.

Début

Implémentations d'interface explicite

  Nom Description
Implémentation d'interface expliciteMéthode privée IEnumerable.GetEnumerator Énumère les documents dans le Tableau en cours d'exécution de document.

Début

Remarques

Le tableau en cours d'exécution de document est utilisé pour suivre tous les documents qui sont actuellement ouverts dans Visual Studio, qu'ils soient visibles ou pas.Un VSPackage (consultez VSPackages) peut accéder au transformer rotatif en appelant la méthode d'IServiceProvider.QueryService sur un fournisseur de services avec l'IDENTIFICATEUR de service du service d'SVsRunningDocumentTable et le GUID de l'interface d'IVsRunningDocumentTable.

Cette classe simplifie l'accès au transformer rotatif pour les VSPackages en masquant les détails de l'interface d'IVsRunningDocumentTable derrière une collection de méthodes utiles.Notez que la classe d'RunningDocumentTable est utilisée uniquement pour les informations de accès de document.Si vous souhaitez suivre des événements de transformer rotatif, vous devez obtenir l'interface d'IVsRunningDocumentTable vous-même (via la méthode d'IServiceProvider.QueryService sur un fournisseur de services) et appeler la méthode d'AdviseRunningDocTableEvents avec votre propre implémentation de l'interface d'IVsRunningDocTableEvents (ou de ses dérivés).

La classe d'Source utilise cette classe pour obtenir le projet propriétaire d'un document en générant la liste de tâches d'erreur pour les fenêtres de tâche.

Remarques à l'attention des appelants

Instanciez cette classe pour obtenir des informations sur un document ouvert.L'objet qui en résulte est en général mis en cache pour améliorer les performances.Notez que cette classe ne fournit pas l'accès terminé au transformer rotatif.

Exemples

Cet exemple montre comment utiliser cette classe d'un service de langage pour obtenir le projet propriétaire d'un fichier actuellement ouvert dans l'éditeur.

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

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.VisualStudio.Shell, espace de noms