Partager via

DocData, classe

  • Article

Une fois substitué dans une classe dérivée, représente un document dans la 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.11.0 (dans Microsoft.VisualStudio.Modeling.Sdk.Shell.11.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 en cours d'exécution de documents.
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 persiste le document.
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 de projet à laquelle le document appartient.
Propriété protégée IsBackupFileObsolete
Propriété publique IsLoaded Obtient le document et le vérifie s'il est chargé.
Propriété publique ItemId Obtient l'ID d'élément qui est assigné au document.
Propriété protégée ServiceProvider Obtient le fournisseur de services du shell.
Propriété publique UndoManager Obtient l'interface d'UndoManager pour le document.
Propriété protégée UndoManagerIsShared Obtient le document et le vérifie si le plusieurs document partage la même interface d'UndoManager.
Propriété publique VSUndoManager Obtient l'interface d'UndoManager.

Début

Méthodes

  Nom Description
Méthode protégée BackupFile Faites une copie de sauvegarde de fichier unique de ce document.Se retourne si supposée le document rechargement sans perte de données.
Méthode protégée CanSave Vérifie si l'utilisateur peut annuler l'opération de sauvegarde.
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 des clients ces un ou plusieurs documents modifiés.
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 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 données de document d'une mémoire tampon.
Méthode publique GetFormatList Obtient la liste de formats de document prises en charge.
Méthode publique GetGuidEditorType Obtient GUID de la fabrique d'éditeur qui a créé l'objet d'IVsPersistDocData.
Méthode publique GetHashCode Sert de fonction de hachage pour un type particulier. (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 Retournez 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 qui ont été levées lorsque le document chargeait.
Méthode protégée HandleSaveDocDataException Gère toutes les exceptions qui ont été levées lorsque le document s'enregistrait.
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é étant donné que l'opération de sauvegarde la plus récente.
Méthode publique IsDocDataDirty Vérifie si le document a changé étant donné que 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 dans la mémoire.
Méthode publique Load(String, UInt32, Int32) Charge le document dans la 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 Marquez que le document a changé et une nouvelle copie de sauvegarde doit être créée donc
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 Alerte des écouteurs que le document a été fermé.
Méthode protégée OnDocumentClosing Alerte des écouteurs que le document sera fermé.
Méthode protégée OnDocumentLoaded Alerte des écouteurs que le document est chargé.
Méthode protégée OnDocumentLoading Alerte des écouteurs que le document sera chargé.
Méthode protégée OnDocumentReadOnlyChanged Alerte des écouteurs que l'état en lecture seule du document a changé.
Méthode protégée OnDocumentReloaded Alerte des écouteurs que le document a été rechargé.
Méthode protégée OnDocumentReloading Alerte des écouteurs que le document sera rechargé.
Méthode protégée OnDocumentSaved Alerte des écouteurs que le document a été enregistré.
Méthode protégée OnDocumentSaving Alerte des écouteurs que le document sera enregistré.
Méthode protégée OnFileNameChanged Alerte des écouteurs que le nom de fichier du document a changé.
Méthode protégée OnHierarchyChanged Alerte des écouteurs que l'ID d'élément qui est assigné au document a changé.
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() Alerte des écouteurs qu'un document est sur le point d'être modifié.Les écouteurs peuvent voter sur la modification.
Méthode publique QueryEditFile(String, tagVSQueryEditFlags) Alerte des écouteurs qu'un document est sur le point d'être modifié.Les écouteurs peuvent voter sur la modification.
Méthode publique QuerySaveFile() Alerte des écouteurs qu'un fichier est sur le point d'être enregistré.Les écouteurs peuvent
Méthode publique QuerySaveFile(String, tagVSQuerySaveFlags) Alerte des écouteurs qu'un fichier est sur le point d'ê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 son emplacement dans la hiérarchie.
Méthode protégée ResumeFileChangeNotification Continue la distribution des notifications en cas de document- modification 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 Alerte des écouteurs que le document a été enregistré.
Méthode publique SaveDocData Enregistre le document à un emplacement spécifique.
Méthode protégée SaveDocDataToFile Enregistre le document à un emplacement spécifique.
Méthode protégée SaveSubordinateFile Enregistrez le document spécifié qui est subordonnée à ce document, par exemple un fichier de diagramme.
Méthode publique SetData Définit le document à une mémoire tampon.
Méthode publique SetDocDataDirty Définit la balise d'IsDirty du document.
Méthode publique SetDocDataReadOnly Définit l'indicateur de lecture seule du document.
Méthode protégée SetFileName Initialise ou modifie le nom de fichier pour le 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 Montre une boîte de dialogue dont l'utilisateur peut spécifier des options supplémentaires pour des formats de sauvegarde.
Méthode protégée SuspendFileChangeNotification Interrompt la distribution des notifications en cas de document- modification 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 après que le document soit fermé.
Événement public DocumentClosing Se produit avant que le document soit fermé.
Événement public DocumentLoaded Se produit après que le document ait été chargé dans la fenêtre de modélisation.
Événement public DocumentLoading Se produit avant que le document soit chargé dans la fenêtre de modélisation.
Événement public DocumentReadOnlyChanged Se produit lorsque l'indicateur de lecture seule pour le document change.
Événement public DocumentReloaded Se produit après que le document soit rechargé.
Événement public DocumentReloading Se produit avant que le document soit rechargé.
Événement public DocumentSaved Se produit après que le document soit enregistré.
Événement public DocumentSaving Se produit avant l'enregistrement du document.
Événement public FileNameChanged Se produit lorsque les modifications de nom de fichier du document.
Événement public HierarchyChanged Se produit lorsque la hiérarchie du document ou les modifications d'ID d'élément.

Début

Implémentations d'interface explicite

  Nom Description
Implémentation d'interface expliciteMéthode privée IVsFileBackup.BackupFile Faites 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 Obtenez si le fichier de sauvegarde est à 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