Partager via

ModelingDocData, classe

  • Article

Représente un document dans le magasin.

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

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 ModelingDocData _
    Inherits DocData _
    Implements IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

[CLSCompliantAttribute(false)]
public abstract class ModelingDocData : DocData, 
    IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

Le type ModelingDocData expose les membres suivants.

Constructeurs

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

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. (Hérité de DocData.)
Propriété publique DocViews Obtient la collection de vues de document ouvertes pour le document. (Hérité de DocData.)
Propriété publique Encoding Obtient ou définit l'encodage qui rend le document persistant. (Hérité de DocData.)
Propriété publique ErrorListProvider Obtient le fournisseur de listes d'erreurs pour le document.
Propriété publique FileName Obtient le nom de fichier du document. (Hérité de DocData.)
Propriété protégée FormatList Obtient une liste de Formats. (Hérité de DocData.)
Propriété publique HasErrorListItems Obtient la liste d'erreurs et vérifie si les erreurs et avertissements pour le document s'affichent dans la fenêtre Liste d'erreurs.
Propriété publique Hierarchy Obtient la hiérarchie du projet à laquelle le document appartient. (Hérité de DocData.)
Propriété protégée InLoad Obtient le document et vérifie s'il est en cours de chargement dans la fenêtre de modélisation.
Propriété protégée InReload Obtient le document et vérifie s'il est en cours de rechargement dans la fenêtre de modélisation.
Propriété protégée IsBackupFileObsolete (Hérité de DocData.)
Propriété publique IsLoaded Obtient le document et vérifie s'il est chargé. (Hérité de DocData.)
Propriété publique ItemId Obtient l'ID d'élément assigné au document. (Hérité de DocData.)
Propriété publique ModelingDocStore Obtient le magasin du concepteur de modélisation qui est assigné au document.
Propriété protégée PartitionMapper
Propriété protégée RelatedDocList
Propriété publique RootElement Obtient l'élément racine dans le document.
Propriété protégée SerializedModel
Propriété protégée ServiceProvider Obtient le fournisseur de services à partir du shell. (Hérité de DocData.)
Propriété publique Store Obtient le magasin du concepteur de modélisation auquel ce document est assigné.
Propriété publique UndoManager Obtient la classe UndoManager que vous pouvez utiliser pour annuler et rétablir les opérations dans le magasin du concepteur de modélisation. (Substitue DocData.UndoManager.)
Propriété protégée UndoManagerIsShared Obtient la classe UndoManager et vérifie si elle est partagée entre les documents. (Substitue DocData.UndoManagerIsShared.)
Propriété publique VSUndoManager Obtient l'interface UndoManager. (Hérité de DocData.)

Début

Méthodes

  Nom Description
Méthode publique AddErrorListItem Ajoute un message d'erreur ou d'avertissement qui peut être utilisé avec le document.
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. (Hérité de DocData.)
Méthode protégée CanSave Vérifie si l'utilisateur peut annuler l'opération d'enregistrement. (Hérité de DocData.)
Méthode protégée CleanupStores Efface les magasins de concepteur de modélisation avant qu'un document ne soit rechargé dans la mémoire.
Méthode publique ClearErrorListItems Efface les messages d'erreur et d'avertissement de la fenêtre Liste d'erreurs.
Méthode publique Close Ferme le document. (Hérité de DocData.)
Méthode protégée CreateModelingDocStore Crée un document pour le magasin du concepteur de modélisation.
Méthode protégée CreateObject Crée un objet
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 protégée CreatePartitionMapper Méthode Factory pour créer le mappeur de partition chargé de mapper des éléments aux partitions correctes du magasin possédé par ce ModelingDocData lorsque les ElementGroupPrototypes sont reconstitués.
Méthode protégée CreateStore Crée un magasin de modélisation.
Méthode protégée CreateSubordinateDocData Créer une instance de données de document subordonnée.
Méthode publique DirectoryChanged Actuellement non implémenté. (Hérité de DocData.)
Méthode protégée Dispose Libère les ressources non managées utilisées par ModelingDocData et libère éventuellement les ressources managées. (Substitue DocData.Dispose(Boolean).)
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é. (Hérité de DocData.)
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 classe UndoManager du magasin. (Substitue DocData.FlushUndoManager().)
Méthode publique GetAllElementsForValidation Obtient tous les éléments pour la validation.L'implémentation de base retourne tous les éléments figurant dans le magasin de ce DocData.
Méthode publique GetClassID Obtient le GUID de la fabrique d'éditeur qui a créé le document. (Hérité de DocData.)
Méthode publique GetCurFile Obtient le nom de fichier du document. (Hérité de DocData.)
Méthode publique GetData Obtient les informations de document à partir d'une mémoire tampon. (Hérité de DocData.)
Méthode protégée GetDomainModels Obtient une collection de types à charger dans le magasin.
Méthode publique GetFormatList Obtient la liste des formats de document pris en charge. (Hérité de DocData.)
Méthode publique GetGuidEditorType Obtient le GUID de la fabrique d'éditeur qui a créé l'objet IVsPersistDocData. (Hérité de DocData.)
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 GetRelatedSaveTreeItems Implémentation standard de IVsHasRelatedSaveItems.Si d'autres DocData ont été enregistrées avec l'interface IRelatedDocList avec cette instance, elles peuvent être retournées comme un RelatedSaveTreeItem.
Méthode publique GetService Propose des services locaux au magasin et aux utilisateurs du fournisseur de services Stores (Substitue DocData.GetService(Type).)
Méthode publique GetTextBuffer Charge le modèle sérialisé dans une nouvelle mémoire tampon.
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. (Hérité de DocData.)
Méthode protégée HandleSaveDocDataException Gère toutes les exceptions levées pendant l'enregistrement du document. (Hérité de DocData.)
Méthode publique HideErrorListItems Masque tous les messages d'erreur et d'avertissement qui se trouvent dans la fenêtre de liste d'erreurs.
Méthode publique IgnoreFileChanges Détermine si des modifications au document doivent être ignorées. (Hérité de DocData.)
Méthode publique Initialize() Initialise la classe ModelingDocData.
Méthode publique Initialize(Store) Initialise le magasin du concepteur de modélisation pour le document.
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. (Hérité de DocData.)
Méthode publique IsDirty Vérifie si le document a changé depuis l'opération de sauvegarde la plus récente. (Hérité de DocData.)
Méthode publique IsDocDataDirty Vérifie si le document a changé depuis l'opération de sauvegarde la plus récente. (Hérité de DocData.)
Méthode publique IsDocDataReadOnly Vérifie si le document est en lecture seule. (Hérité de DocData.)
Méthode publique IsDocDataReloadable Vérifie si le document peut être rechargé. (Hérité de DocData.)
Méthode protégée IsFlushUndoStackRequiredOnLoad Remplacez cette méthode pour spécifier si la pile d'annulations doit être vidée après avoir chargé (ouvert ou créé) les DocData.
Méthode protégée Load(String, Boolean) Charge le document en mémoire. (Hérité de DocData.)
Méthode publique Load(String, UInt32, Int32) Charge le document en mémoire. (Hérité de DocData.)
Méthode publique LoadDocData(String) Charge le document en utilisant son nom de fichier. (Hérité de DocData.)
Méthode protégée LoadDocData(String, Boolean) Charge un document qui a un nom de fichier spécifique. (Substitue DocData.LoadDocData(String, Boolean).)
Méthode publique LockTextBuffer Non implémenté.
Méthode publique MarkDocumentChangedForBackup Marque que le document a été modifié et qu'une sauvegarde doit donc être créée (Hérité de DocData.)
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 Appelée lorsque le document est fermé.Le comportement par défaut efface le contenu de la liste d'erreurs. (Substitue DocData.OnDocumentClosed(EventArgs).)
Méthode protégée OnDocumentClosing Avertit les écouteurs que le document sera fermé. (Hérité de DocData.)
Méthode protégée OnDocumentLoaded Avertit les écouteurs que le document est chargé. (Hérité de DocData.)
Méthode protégée OnDocumentLoading Avertit les écouteurs que le document sera chargé. (Hérité de DocData.)
Méthode protégée OnDocumentReadOnlyChanged Avertit les écouteurs que l'état de lecture seule du document a été modifié. (Hérité de DocData.)
Méthode protégée OnDocumentReloaded Avertit les écouteurs que le document a été rechargé. (Hérité de DocData.)
Méthode protégée OnDocumentReloading Avertit les écouteurs que le document sera rechargé. (Hérité de DocData.)
Méthode protégée OnDocumentSaved Avertit les écouteurs que le document a été sauvegardé. (Hérité de DocData.)
Méthode protégée OnDocumentSaving Avertit les écouteurs que le document sera sauvegardé. (Hérité de DocData.)
Méthode protégée OnFileNameChanged Avertit les écouteurs que le nom de fichier du document a été modifié. (Hérité de DocData.)
Méthode protégée OnHierarchyChanged Appelée lorsqu'un document est ajouté ou renommé. (Substitue DocData.OnHierarchyChanged(EventArgs).)
Méthode publique OnRegisterDocData Assigne le document à une hiérarchie de cookie et de projet. (Hérité de DocData.)
Méthode publique OpenView Ouvre une vue spécifique pour le document. (Substitue DocData.OpenView(Guid, Object).)
Méthode publique QueryEditFile() Avertit les écouteurs qu'un document est sur le point d'être modifié.Les écouteurs peuvent voter contre la modification. (Hérité de DocData.)
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. (Hérité de DocData.)
Méthode publique QuerySaveFile() Alerte les écouteurs qu'un fichier va être enregistré.Les écouteurs peuvent (Hérité de DocData.)
Méthode publique QuerySaveFile(String, tagVSQuerySaveFlags) Alerte les écouteurs qu'un fichier va être enregistré. (Hérité de DocData.)
Méthode publique ReloadDocData Recharge le document. (Hérité de DocData.)
Méthode protégée ReloadDocDataWorker Recharge le document. (Hérité de DocData.)
Méthode publique RenameDocData Renomme un document et réinitialise sa position dans la hiérarchie. (Hérité de DocData.)
Méthode publique ResumeErrorListRefresh Actualise la fenêtre Liste d'erreurs chaque fois qu'une erreur ou un message d'avertissement est ajouté pour le document.
Méthode protégée ResumeFileChangeNotification Reprend la distribution des notifications de modification de document pour le document. (Hérité de DocData.)
Méthode protégée Save(String) Enregistre le document. (Hérité de DocData.)
Méthode publique Save(String, Int32, UInt32) Enregistre le document. (Hérité de DocData.)
Méthode publique SaveCompleted Avertit les écouteurs que le document a été sauvegardé. (Hérité de DocData.)
Méthode publique SaveDocData Enregistre le document à l'emplacement spécifié. (Hérité de DocData.)
Méthode protégée SaveDocDataToFile Enregistre le document à l'emplacement spécifié. (Hérité de DocData.)
Méthode protégée SaveSubordinateFile Enregistre le document spécifié qui est subordonné à ce document, par exemple un fichier de diagramme. (Hérité de DocData.)
Méthode publique SetData Place le document dans une mémoire tampon. (Hérité de DocData.)
Méthode publique SetDocDataDirty Définit l'indicateur IsDirty du document. (Hérité de DocData.)
Méthode publique SetDocDataReadOnly Définit l'indicateur en lecture seule du document. (Hérité de DocData.)
Méthode protégée SetFileName Initialise ou modifie le nom de fichier du document. (Hérité de DocData.)
Méthode protégée SetHierarchyInfo Initialise ou modifie la hiérarchie de projet pour le document. (Hérité de DocData.)
Méthode protégée SetRootElement Définit l'élément racine.
Méthode publique SetTextBuffer Non implémenté.
Méthode publique SetUntitledDocPath Actuellement non implémenté. (Hérité de DocData.)
Méthode publique ShowErrorListItems Affiche tous les messages d'erreur et d'avertissement dans la fenêtre Liste d'erreurs.
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. (Hérité de DocData.)
Méthode publique SupportsLogicalView Vérifie si le document prend en charge la vue spécifiée.
Méthode publique SuspendErrorListRefresh Empêche la fenêtre Error List de s'actualiser.
Méthode protégée SuspendFileChangeNotification Interrompt la distribution des notifications de modification de document pour le document. (Hérité de DocData.)
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é. (Hérité de DocData.)
Événement public DocumentClosing Se produit avant la fermeture du document. (Hérité de DocData.)
Événement public DocumentLoaded Se produit après que le document a été chargé dans la fenêtre de modélisation. (Hérité de DocData.)
Événement public DocumentLoading Se produit avant que le document ne soit chargé dans la fenêtre de modélisation. (Hérité de DocData.)
Événement public DocumentReadOnlyChanged Se produit lorsque l'indicateur de lecture seule change pour le document. (Hérité de DocData.)
Événement public DocumentReloaded Se produit une fois le document rechargé. (Hérité de DocData.)
Événement public DocumentReloading Se produit avant le rechargement du document. (Hérité de DocData.)
Événement public DocumentSaved Se produit après l'enregistrement du document. (Hérité de DocData.)
Événement public DocumentSaving Se produit avant l'enregistrement du document. (Hérité de DocData.)
Événement public FileNameChanged Se produit lorsque le nom de fichier du document change. (Hérité de DocData.)
Événement public HierarchyChanged Se produit lorsque la hiérarchie ou l'ID d'élément du document change. (Hérité de DocData.)

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. (Hérité de DocData.)
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. (Hérité de 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. (Hérité de DocData.)
Implémentation d'interface expliciteMéthode privée IVsFileBackup.IsBackupFileObsolete Définit que le fichier de sauvegarde soit à jour. (Hérité de DocData.)

Début

Notes

Le document en mémoire est sauvegardé à un stockage en mémoire.

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