Freigeben über

DocData-Klasse

  • Artikel

Stellt beim Überschreiben in einer abgeleiteten Klasse ein Dokument im Arbeitsspeicher dar.

Diese API ist nicht CLS-kompatibel. 

Vererbungshierarchie

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

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
<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

Der DocData-Typ macht die folgenden Member verfügbar.

Konstruktoren

  Name Beschreibung
Geschützte Methode DocData Initialisiert eine neue Instanz der DocData-Klasse.

Zum Seitenanfang

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft Cookie Ruft das Cookie ab, das das Dokument in der Running-Documents-Tabelle identifiziert.
Öffentliche Eigenschaft DocViews Ruft die Auflistung von Dokumentansichten ab, die für das Dokument geöffnet sind.
Öffentliche Eigenschaft Encoding Ruft die Codierung ab, die das Dokument beibehält, oder legt diese fest.
Öffentliche Eigenschaft FileName Ruft den Dateinamen des Dokuments ab.
Geschützte Eigenschaft FormatList Ruft eine Liste mit Formaten ab.
Öffentliche Eigenschaft Hierarchy Ruft die Hierarchie des Projekts ab, zu dem das Dokument gehört.
Geschützte Eigenschaft IsBackupFileObsolete
Öffentliche Eigenschaft IsLoaded Ruft das Dokument ab und überprüft, ob es geladen wird.
Öffentliche Eigenschaft ItemId Ruft die Element-ID ab, die dem Dokument zugewiesen ist.
Geschützte Eigenschaft ServiceProvider Ruft den Dienstanbieter von der Shell ab.
Öffentliche Eigenschaft UndoManager Ruft UndoManager für die Schnittstelle ab.
Geschützte Eigenschaft UndoManagerIsShared Ruft das Dokument ab und überprüft, ob mehr als ein Dokument die gleiche UndoManager-Schnittstelle verwendet.
Öffentliche Eigenschaft VSUndoManager Ruft die UndoManager-Schnittstelle ab.

Zum Seitenanfang

Methoden

  Name Beschreibung
Geschützte Methode BackupFile Führen Sie eine Sicherung einzelner Dateien dieses Dokuments durch.Gibt zurück, ob erwartet wird, dass das Dokument ohne Datenverlust erneut lädt.
Geschützte Methode CanSave Überprüft, ob der Benutzer den Speichervorgang abbrechen kann.
Öffentliche Methode Close Schließt das Dokument.
Öffentliche Methode CreateObjRef Sicherheitsrelevant. Erstellt ein Objekt mit allen relevanten Informationen, die zum Generieren eines Proxys für die Kommunikation mit einem Remoteobjekt erforderlich sind. (Von MarshalByRefObject geerbt.)
Öffentliche Methode DirectoryChanged Derzeit nicht implementiert.
Geschützte Methode Dispose Gibt die von DocData verwendeten nicht verwalteten Ressourcen und optional die verwalteten Ressourcen frei.
Öffentliche Methode Equals Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist. (Von Object geerbt.)
Öffentliche Methode FilesChanged Benachrichtigt Clients, dass ein oder mehrere Dokumente geändert wurden.
Geschützte Methode Finalize Gibt einem Objekt Gelegenheit zu dem Versuch, Ressourcen freizugeben und andere Bereinigungen durchzuführen, bevor es von der Garbage Collection freigegeben wird. (Von Object geerbt.)
Öffentliche Methode FlushUndoManager Löscht die UndoManager.
Öffentliche Methode GetClassID Ruft die GUID der Editorfactory ab, die das Dokument erstellt hat.
Öffentliche Methode GetCurFile Ruft den Dateinamen des Dokuments ab.
Öffentliche Methode GetData Ruft die Dokumentdaten aus einem Puffer ab.
Öffentliche Methode GetFormatList Ruft die Liste der unterstützten Dokumentformate ab.
Öffentliche Methode GetGuidEditorType Ruft die GUID der Editorfactory ab, die das IVsPersistDocData-Objekt erstellt hat.
Öffentliche Methode GetHashCode Fungiert als die Standardhashfunktion. (Von Object geerbt.)
Öffentliche Methode GetLifetimeService Sicherheitsrelevant. Ruft das aktuelle Lebensdauerdienstobjekt ab, das die Lebensdauerrichtlinien für diese Instanz steuert. (Von MarshalByRefObject geerbt.)
Öffentliche Methode GetService Geben Sie den angeforderten Dienst zurück.
Öffentliche Methode GetType Ruft den Type der aktuellen Instanz ab. (Von Object geerbt.)
Geschützte Methode HandleLoadDocDataException Verwaltet alle Ausnahmen, die ausgelöst wurden, als das Dokument geladen wurde.
Geschützte Methode HandleSaveDocDataException Verwaltet alle Ausnahmen, die ausgelöst wurden, als das Dokument gespeichert wurde.
Öffentliche Methode IgnoreFileChanges Bestimmt, ob Änderungen am Dokument ignoriert werden sollen.
Öffentliche Methode InitializeLifetimeService Sicherheitsrelevant. Ruft ein Lebensdauerdienstobjekt ab, mit dem die Lebensdauerrichtlinien für diese Instanz gesteuert werden können. (Von MarshalByRefObject geerbt.)
Öffentliche Methode InitNew Initialisiert das Dokument.
Öffentliche Methode IsDirty Überprüft, ob das Dokument seit dem letzten Speichervorgang geändert wurde.
Öffentliche Methode IsDocDataDirty Überprüft, ob das Dokument seit dem letzten Speichervorgang geändert wurde.
Öffentliche Methode IsDocDataReadOnly Überprüft, ob das Dokument schreibgeschützt ist.
Öffentliche Methode IsDocDataReloadable Überprüft, ob das Dokument erneut geladen werden kann.
Geschützte Methode Load(String, Boolean) Das Dokument wird in den Speicher geladen.
Öffentliche Methode Load(String, UInt32, Int32) Das Dokument wird in den Speicher geladen.
Öffentliche Methode LoadDocData(String) Lädt das Dokument unter Verwendung des Dateinamens.
Geschützte Methode LoadDocData(String, Boolean) Lädt das Dokument unter Verwendung des Dateinamens.
Öffentliche Methode MarkDocumentChangedForBackup Markieren Sie, dass das Dokument geändert wurde und daher eine neue Sicherung erstellt werden soll.
Geschützte Methode MemberwiseClone() Erstellt eine flache Kopie des aktuellen Object. (Von Object geerbt.)
Geschützte Methode MemberwiseClone(Boolean) Erstellt eine flache Kopie des aktuellen MarshalByRefObject-Objekts. (Von MarshalByRefObject geerbt.)
Geschützte Methode OnDocumentClosed Alarmiert Listener, dass das Dokument geschlossen wurde.
Geschützte Methode OnDocumentClosing Alarmiert Listener, dass das Dokument geschlossen wird.
Geschützte Methode OnDocumentLoaded Alarmiert Listener, dass das Dokument geladen wird.
Geschützte Methode OnDocumentLoading Alarmiert Listener, dass das Dokument geladen wird.
Geschützte Methode OnDocumentReadOnlyChanged Alarmiert Listener, dass sich der schreibgeschützten Zustand des Dokuments geändert hat.
Geschützte Methode OnDocumentReloaded Alarmiert Listener, dass das Dokument erneut geladen wurde.
Geschützte Methode OnDocumentReloading Alarmiert Listener, dass das Dokument erneut geladen wird.
Geschützte Methode OnDocumentSaved Alarmiert Listener, dass das Dokument gespeichert wurde.
Geschützte Methode OnDocumentSaving Alarmiert Listener, dass das Dokument gespeichert wird.
Geschützte Methode OnFileNameChanged Alarmiert Listener, dass sich der Dateiname des Dokuments geändert hat.
Geschützte Methode OnHierarchyChanged Alarmiert Listener, dass die Element-ID, die dem Dokument zugeordnet ist, geändert wurde.
Öffentliche Methode OnRegisterDocData Weist das Dokument einer Cookie- und Projekthierarchie zu.
Öffentliche Methode OpenView Öffnet eine bestimmte Ansicht für das Dokument.
Öffentliche Methode QueryEditFile() Alarmiert Listener, dass ein Dokument gerade bearbeitet wird.Listener können die Option "Bearbeiten" ablehnen.
Öffentliche Methode QueryEditFile(String, tagVSQueryEditFlags) Alarmiert Listener, dass ein Dokument gerade bearbeitet wird.Listener können die Option "Bearbeiten" ablehnen.
Öffentliche Methode QuerySaveFile() Alarmiert Listener, dass eine Datei gespeichert werden soll.Listener können
Öffentliche Methode QuerySaveFile(String, tagVSQuerySaveFlags) Alarmiert Listener, dass eine Datei gespeichert werden soll.
Öffentliche Methode ReloadDocData Lädt das Dokument erneut.
Geschützte Methode ReloadDocDataWorker Lädt das Dokument erneut.
Öffentliche Methode RenameDocData Benennt ein Dokument um und setzt seine Position in der Hierarchie zurück.
Geschützte Methode ResumeFileChangeNotification Setzt die Verteilung von Dokumentänderungsbenachrichtigungen für das Dokument fort.
Geschützte Methode Save(String) Speichert das Dokument.
Öffentliche Methode Save(String, Int32, UInt32) Speichert das Dokument.
Öffentliche Methode SaveCompleted Alarmiert Listener, dass das Dokument gespeichert wurde.
Öffentliche Methode SaveDocData Speichert das XML-Dokument am angegebenen Speicherort.
Geschützte Methode SaveDocDataToFile Speichert das XML-Dokument am angegebenen Speicherort.
Geschützte Methode SaveSubordinateFile Das angegebene Dokument, das diesem Dokument untergeordnet ist, z. B. eine Diagrammdatei, speichern.
Öffentliche Methode SetData Legt das Dokument auf einen Puffer fest.
Öffentliche Methode SetDocDataDirty Legt das IsDirty-Flag des Dokuments fest.
Öffentliche Methode SetDocDataReadOnly Legt das Schreibschutzflag des Dokuments fest.
Geschützte Methode SetFileName Initialisiert oder ändert den Dateinamen für das Dokument.
Geschützte Methode SetHierarchyInfo Initialisiert oder ändert die Projekthierarchie für das Dokument.
Öffentliche Methode SetUntitledDocPath Derzeit nicht implementiert.
Öffentliche Methode ShowSaveOptionsDlg Zeigt ein Dialogfeld an, aus dem der Benutzer zusätzliche Optionen für das Speichern von Formaten angeben kann.
Geschützte Methode SuspendFileChangeNotification Hält die Verteilung von Dokumentänderungsbenachrichtigungen für das Dokument an.
Öffentliche Methode ToString Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Von Object geerbt.)

Zum Seitenanfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis DocumentClosed Tritt ein, nachdem ein Dokument geschlossen wurde.
Öffentliches Ereignis DocumentClosing Tritt ein, bevor das Dokument geschlossen wird.
Öffentliches Ereignis DocumentLoaded Tritt auf, nachdem das Dokument im Modellierungsfenster geladen wurde.
Öffentliches Ereignis DocumentLoading Tritt ein, bevor das Dokument im Modellierungsfenster geladen wird.
Öffentliches Ereignis DocumentReadOnlyChanged Tritt ein, wenn sich das Schreibschutzflag für das Dokument ändert.
Öffentliches Ereignis DocumentReloaded Tritt ein, nachdem ein Dokument erneut geladen wurde.
Öffentliches Ereignis DocumentReloading Wird ausgelöst, bevor das Dokument neu geladen wird.
Öffentliches Ereignis DocumentSaved Tritt ein, nachdem die Dokument gespeichert wurde.
Öffentliches Ereignis DocumentSaving Wird ausgelöst, bevor das Dokument gespeichert wird.
Öffentliches Ereignis FileNameChanged Tritt ein, wenn sich der Dateiname des Dokuments ändert.
Öffentliches Ereignis HierarchyChanged Tritt ein, wenn sich die Hierarchie oder Element-ID des Dokuments ändert.

Zum Seitenanfang

Explizite Schnittstellen implementierungen

  Name Beschreibung
Explizite SchnittstellenimplementierungPrivate Methode IVsFileBackup.BackupFile Führen Sie eine Sicherung einzelner Dateien dieses Dokuments durch.
Explizite SchnittstellenimplementierungPrivate Methode IDisposable.Dispose Gibt alle von der aktuellen Instanz der DocData-Klasse verwendeten Ressourcen frei.
Explizite SchnittstellenimplementierungPrivate Methode IPersistFileFormat.GetClassID Ruft den Klassenbezeichner der Editorfactory ab, die das Dokument erstellt hat.
Explizite SchnittstellenimplementierungPrivate Methode IVsFileBackup.IsBackupFileObsolete Ruft ab, ob die Sicherungsdatei auf dem neuesten Stand ist.

Zum Seitenanfang

Hinweise

Diese Klasse auch überwacht, um Ereignisse für externe Dokumente ändern und kann den Benutzer auffordern, das Dokument erneut zu laden.

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

Siehe auch

Referenz

Microsoft.VisualStudio.Modeling.Shell-Namespace