Partager via

DocData, classe

  • Article

En cas de substitution dans une classe dérivée, représente un document en mémoire.

Cette API n'est pas conforme CLS. 

Hiérarchie d'héritage

System.Object
  System.MarshalByRefObject
    Microsoft.VisualStudio.Modeling.Shell.DocData
      Microsoft.VisualStudio.Modeling.Shell.ModelingDocData
      Microsoft.VisualStudio.Modeling.Shell.SubordinateDocData

Espace de noms :  Microsoft.VisualStudio.Modeling.Shell
Assembly :  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (dans Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntaxe

'Déclaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class DocData _
    Inherits MarshalByRefObject _
    Implements IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl,  _
    IPersistFileFormat, IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData,  _
    IVsFileBackup, IServiceProvider

[CLSCompliantAttribute(false)]
public abstract class DocData : MarshalByRefObject, 
    IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl, IPersistFileFormat, 
    IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData, IVsFileBackup, 
    IServiceProvider

Le type DocData expose les membres suivants.

Constructeurs

  Nom Description
Méthode protégée DocData Initialise une nouvelle instance de la classe DocData.

Début

Propriétés

  Nom Description
Propriété publique Cookie Obtient le cookie qui identifie le document dans le tableau Documents en cours d'exécution.
Propriété publique DocViews Obtient la collection de vues de document ouvertes pour le document.
Propriété publique Encoding Obtient ou définit l'encodage qui rend le document persistant.
Propriété publique FileName Obtient le nom de fichier du document.
Propriété protégée FormatList Obtient une liste de Formats.
Propriété publique Hierarchy Obtient la hiérarchie du projet à laquelle le document appartient.
Propriété protégée IsBackupFileObsolete
Propriété publique IsLoaded Obtient le document et vérifie s'il est chargé.
Propriété publique ItemId Obtient l'ID d'élément assigné au document.
Propriété protégée ServiceProvider Obtient le fournisseur de services à partir du shell.
Propriété publique UndoManager Obtient l'interface UndoManager pour le document.
Propriété protégée UndoManagerIsShared Obtient le document et vérifie si plusieurs documents partagent la même interface UndoManager .
Propriété publique VSUndoManager Obtient l'interface UndoManager.

Début

Méthodes

  Nom Description
Méthode protégée BackupFile Effectue une copie de sauvegarde de fichier unique de ce document.Retourne si le document doit être rechargé sans perte de données.
Méthode protégée CanSave Vérifie si l'utilisateur peut annuler l'opération d'enregistrement.
Méthode publique Close Ferme le document.
Méthode publique CreateObjRef Essentiel pour la sécurité. Crée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant. (Hérité de MarshalByRefObject.)
Méthode publique DirectoryChanged Actuellement non implémenté.
Méthode protégée Dispose Libère les ressources non managées utilisées par DocData et libère éventuellement les ressources managées.
Méthode publique Equals Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.)
Méthode publique FilesChanged Informe les clients qu'un ou plusieurs documents ont changé.
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 FlushUndoManager Efface la UndoManager.
Méthode publique GetClassID Obtient le GUID de la fabrique d'éditeur qui a créé le document.
Méthode publique GetCurFile Obtient le nom de fichier du document.
Méthode publique GetData Obtient les informations de document à partir d'une mémoire tampon.
Méthode publique GetFormatList Obtient la liste des formats de document pris en charge.
Méthode publique GetGuidEditorType Obtient le GUID de la fabrique d'éditeur qui a créé l'objet IVsPersistDocData.
Méthode publique GetHashCode Sert de fonction de hachage par défaut. (Hérité de Object.)
Méthode publique GetLifetimeService Essentiel pour la sécurité. Récupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject.)
Méthode publique GetService Retourne le service demandé.
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode protégée HandleLoadDocDataException Gère toutes les exceptions levées pendant le chargement du document.
Méthode protégée HandleSaveDocDataException Gère toutes les exceptions levées pendant l'enregistrement du document.
Méthode publique IgnoreFileChanges Détermine si des modifications au document doivent être ignorées.
Méthode publique InitializeLifetimeService Essentiel pour la sécurité. Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject.)
Méthode publique InitNew Initialise le document.
Méthode publique IsDirty Vérifie si le document a changé depuis l'opération de sauvegarde la plus récente.
Méthode publique IsDocDataDirty Vérifie si le document a changé depuis l'opération de sauvegarde la plus récente.
Méthode publique IsDocDataReadOnly Vérifie si le document est en lecture seule.
Méthode publique IsDocDataReloadable Vérifie si le document peut être rechargé.
Méthode protégée Load(String, Boolean) Charge le document en mémoire.
Méthode publique Load(String, UInt32, Int32) Charge le document en mémoire.
Méthode publique LoadDocData(String) Charge le document en utilisant son nom de fichier.
Méthode protégée LoadDocData(String, Boolean) Charge le document en utilisant son nom de fichier.
Méthode publique MarkDocumentChangedForBackup Marque que le document a été modifié et qu'une sauvegarde doit donc être créée
Méthode protégée MemberwiseClone() Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
Méthode protégée MemberwiseClone(Boolean) Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject.)
Méthode protégée OnDocumentClosed Avertit les écouteurs que le document est fermé.
Méthode protégée OnDocumentClosing Avertit les écouteurs que le document sera fermé.
Méthode protégée OnDocumentLoaded Avertit les écouteurs que le document est chargé.
Méthode protégée OnDocumentLoading Avertit les écouteurs que le document sera chargé.
Méthode protégée OnDocumentReadOnlyChanged Avertit les écouteurs que l'état de lecture seule du document a été modifié.
Méthode protégée OnDocumentReloaded Avertit les écouteurs que le document a été rechargé.
Méthode protégée OnDocumentReloading Avertit les écouteurs que le document sera rechargé.
Méthode protégée OnDocumentSaved Avertit les écouteurs que le document a été sauvegardé.
Méthode protégée OnDocumentSaving Avertit les écouteurs que le document sera sauvegardé.
Méthode protégée OnFileNameChanged Avertit les écouteurs que le nom de fichier du document a été modifié.
Méthode protégée OnHierarchyChanged Avertit les écouteurs que l'ID de l'élément assigné au document a été modifié.
Méthode publique OnRegisterDocData Assigne le document à une hiérarchie de cookie et de projet.
Méthode publique OpenView Ouvre une vue spécifique pour le document.
Méthode publique QueryEditFile() Avertit les écouteurs qu'un document est sur le point d'être modifié.Les écouteurs peuvent voter contre la modification.
Méthode publique QueryEditFile(String, tagVSQueryEditFlags) Avertit les écouteurs qu'un document est sur le point d'être modifié.Les écouteurs peuvent voter contre la modification.
Méthode publique QuerySaveFile() Alerte les écouteurs qu'un fichier va être enregistré.Les écouteurs peuvent
Méthode publique QuerySaveFile(String, tagVSQuerySaveFlags) Alerte les écouteurs qu'un fichier va être enregistré.
Méthode publique ReloadDocData Recharge le document.
Méthode protégée ReloadDocDataWorker Recharge le document.
Méthode publique RenameDocData Renomme un document et réinitialise sa position dans la hiérarchie.
Méthode protégée ResumeFileChangeNotification Reprend la distribution des notifications de modification de document pour le document.
Méthode protégée Save(String) Enregistre le document.
Méthode publique Save(String, Int32, UInt32) Enregistre le document.
Méthode publique SaveCompleted Avertit les écouteurs que le document a été sauvegardé.
Méthode publique SaveDocData Enregistre le document à l'emplacement spécifié.
Méthode protégée SaveDocDataToFile Enregistre le document à l'emplacement spécifié.
Méthode protégée SaveSubordinateFile Enregistre le document spécifié qui est subordonné à ce document, par exemple un fichier de diagramme.
Méthode publique SetData Place le document dans une mémoire tampon.
Méthode publique SetDocDataDirty Définit l'indicateur IsDirty du document.
Méthode publique SetDocDataReadOnly Définit l'indicateur en lecture seule du document.
Méthode protégée SetFileName Initialise ou modifie le nom de fichier du document.
Méthode protégée SetHierarchyInfo Initialise ou modifie la hiérarchie de projet pour le document.
Méthode publique SetUntitledDocPath Actuellement non implémenté.
Méthode publique ShowSaveOptionsDlg Affiche une boîte de dialogue dans laquelle l'utilisateur peut spécifier des options supplémentaires pour les formats d'enregistrement.
Méthode protégée SuspendFileChangeNotification Interrompt la distribution des notifications de modification de document pour le document.
Méthode publique ToString Retourne une chaîne qui représente l'objet actif. (Hérité de Object.)

Début

Événements

  Nom Description
Événement public DocumentClosed Se produit une fois le document fermé.
Événement public DocumentClosing Se produit avant la fermeture du document.
Événement public DocumentLoaded Se produit après que le document a été chargé dans la fenêtre de modélisation.
Événement public DocumentLoading Se produit avant que le document ne soit chargé dans la fenêtre de modélisation.
Événement public DocumentReadOnlyChanged Se produit lorsque l'indicateur de lecture seule change pour le document.
Événement public DocumentReloaded Se produit une fois le document rechargé.
Événement public DocumentReloading Se produit avant le rechargement du document.
Événement public DocumentSaved Se produit après l'enregistrement du document.
Événement public DocumentSaving Se produit avant l'enregistrement du document.
Événement public FileNameChanged Se produit lorsque le nom de fichier du document change.
Événement public HierarchyChanged Se produit lorsque la hiérarchie ou l'ID d'élément du document change.

Début

Implémentations d'interface explicite

  Nom Description
Implémentation d'interface expliciteMéthode privée IVsFileBackup.BackupFile Effectue une copie de sauvegarde de fichier unique de ce document.
Implémentation d'interface expliciteMéthode privée IDisposable.Dispose Libère toutes les ressources utilisées par l'instance actuelle de la classe DocData.
Implémentation d'interface expliciteMéthode privée IPersistFileFormat.GetClassID Obtient l'ID de classe de la fabrique d'éditeur qui a créé le document.
Implémentation d'interface expliciteMéthode privée IVsFileBackup.IsBackupFileObsolete Définit que le fichier de sauvegarde soit à jour.

Début

Notes

Cette classe également écoute pour modifier des événements pour les documents externes et peut inviter l'utilisateur à recharger le document.

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.Modeling.Shell, espace de noms