Sdílet prostřednictvím


DocData – třída

V odvozené třídě přepsána, představuje dokumentů v paměti.

Toto rozhraní API není kompatibilní se specifikací CLS. 

Hierarchie dědičnosti

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

Obor názvů:  Microsoft.VisualStudio.Modeling.Shell
Sestavení:  Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (v Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntaxe

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

Typ DocData zveřejňuje následující členy.

Konstruktory

  Název Popis
Chráněná metoda DocData Vytvoří novou instanci třídy DocData.

Nahoru

Vlastnosti

  Název Popis
Veřejná vlastnost Cookie Získává cookie, který identifikuje dokumentu v tabulce s dokumenty.
Veřejná vlastnost DocViews Získá kolekce zobrazení dokumentu, které jsou otevřené pro dokument.
Veřejná vlastnost Encoding Získá nebo nastaví kódování dokumentu přetrvává.
Veřejná vlastnost FileName Získá název souboru dokumentu.
Chráněná vlastnost FormatList Získá seznam formátů.
Veřejná vlastnost Hierarchy Získá hierarchii projektu, k němuž patří dokument.
Chráněná vlastnost IsBackupFileObsolete
Veřejná vlastnost IsLoaded Dokument obdrží a ověří, zda je načten.
Veřejná vlastnost ItemId Načte ID položky, která je přiřazena k dokumentu.
Chráněná vlastnost ServiceProvider Poskytovatel metadat získává z prostředí.
Veřejná vlastnost UndoManager Získává UndoManager rozhraní pro dokument.
Chráněná vlastnost UndoManagerIsShared Získá dokumentu a ověří, zda je více než jeden dokument sdílení stejné UndoManager rozhraní.
Veřejná vlastnost VSUndoManager Získává UndoManager rozhraní.

Nahoru

Metody

  Název Popis
Chráněná metoda BackupFile Vytvořte zálohu tohoto dokumentu do jednoho souboru.Vrátí se, zda dokument má re-load bez ztráty dat..
Chráněná metoda CanSave Ověří, zda uživatel může zrušit ukládání operace.
Veřejná metoda Close Zavře dokument.
Veřejná metoda CreateObjRef Kritické pro zabezpečení Vytvoří objekt, který obsahuje všechny příslušné informace potřebné pro generování proxy používají ke komunikaci s vzdálený objekt. (Zděděno z MarshalByRefObject.)
Veřejná metoda DirectoryChanged Není aktuálně implementováno.
Chráněná metoda Dispose Uvolní nespravované prostředky používané DocData a volitelně uvolní spravované prostředky.
Veřejná metoda Equals Určuje, zda zadaný objekt je rovno aktuální objekt. (Zděděno z Object.)
Veřejná metoda FilesChanged Upozorní klienty, že změněn jeden nebo více dokumentů.
Chráněná metoda Finalize Umožňuje objekt při uvolnění prostředků a provádět jiné operace vyčištění, dříve, než je zažádáno systémem uvolňování paměti. (Zděděno z Object.)
Veřejná metoda FlushUndoManager Vymaže UndoManager.
Veřejná metoda GetClassID Získá identifikátor GUID editor výroby, které byl dokument vytvořen.
Veřejná metoda GetCurFile Získá název souboru dokumentu.
Veřejná metoda GetData Získává data dokumentu z vyrovnávací paměti.
Veřejná metoda GetFormatList Získá seznam podporované formáty dokumentů.
Veřejná metoda GetGuidEditorType Identifikátor GUID factory editor, který vytvořili získává IVsPersistDocData objektu.
Veřejná metoda GetHashCode Slouží jako funkci hash u určitého typu. (Zděděno z Object.)
Veřejná metoda GetLifetimeService Kritické pro zabezpečení Načte aktuální životnost objektu služby, ovládající zásady platnosti pro tuto instanci. (Zděděno z MarshalByRefObject.)
Veřejná metoda GetService Vrátí požadované služby.
Veřejná metoda GetType Získá Type aktuální instance. (Zděděno z Object.)
Chráněná metoda HandleLoadDocDataException Spravuje všechny výjimky, které byly vyvolány, když byl načítání dokumentu.
Chráněná metoda HandleSaveDocDataException Spravuje všechny výjimky, které byly vyvolány při ukládání dokumentu.
Veřejná metoda IgnoreFileChanges Určuje, zda budou ignorovány změny dokumentu.
Veřejná metoda InitializeLifetimeService Kritické pro zabezpečení Získá objektu životnost služby řízení zásad platnosti pro tuto instanci. (Zděděno z MarshalByRefObject.)
Veřejná metoda InitNew Inicializuje dokumentu.
Veřejná metoda IsDirty Ověří, zda dokument byl změněn poslední operaci uložení.
Veřejná metoda IsDocDataDirty Ověří, zda dokument byl změněn poslední operaci uložení.
Veřejná metoda IsDocDataReadOnly Ověří, zda dokument je jen pro čtení.
Veřejná metoda IsDocDataReloadable Ověří, zda lze dokument znovu načteny.
Chráněná metoda Load(String, Boolean) Dokument se načte do paměti.
Veřejná metoda Load(String, UInt32, Int32) Dokument se načte do paměti.
Veřejná metoda LoadDocData(String) Načte dokument pomocí názvu souboru.
Chráněná metoda LoadDocData(String, Boolean) Načte dokument pomocí názvu souboru.
Veřejná metoda MarkDocumentChangedForBackup Značka, která dokument změnil, a proto by měl být vytvořen nový zálohování
Chráněná metoda MemberwiseClone() Vytvoří kopii aktuálního Object. (Zděděno z Object.)
Chráněná metoda MemberwiseClone(Boolean) Vytvoří kopii aktuální MarshalByRefObject objektu. (Zděděno z MarshalByRefObject.)
Chráněná metoda OnDocumentClosed Upozornění posluchače, že dokument byl uzavřen.
Chráněná metoda OnDocumentClosing Upozornění posluchače, že dokument bude uzavřen.
Chráněná metoda OnDocumentLoaded Upozornění posluchače je dokument načten.
Chráněná metoda OnDocumentLoading Upozornění posluchače, že dokument bude načten.
Chráněná metoda OnDocumentReadOnlyChanged Upozornění posluchače, aby se změnil stav jen pro čtení dokumentu.
Chráněná metoda OnDocumentReloaded Upozornění posluchače, aby byla znovu vložený dokument.
Chráněná metoda OnDocumentReloading Znovu vložený dokument upozornění posluchače.
Chráněná metoda OnDocumentSaved Uložení dokumentu upozornění posluchače.
Chráněná metoda OnDocumentSaving Upozornění posluchače, že dokument uložit.
Chráněná metoda OnFileNameChanged Upozornění posluchače, že byl změněn název souboru dokumentu.
Chráněná metoda OnHierarchyChanged Upozornění posluchače, že došlo ke změně ID položky, která je přiřazena k dokumentu.
Veřejná metoda OnRegisterDocData Přiřadí cookie a projektu hierarchii dokumentu.
Veřejná metoda OpenView Otevře zobrazení určitého dokumentu.
Veřejná metoda QueryEditFile() Posluchače výstrahy, které je dokument bude upraven.Posluchače hlasovat proti úpravy.
Veřejná metoda QueryEditFile(String, tagVSQueryEditFlags) Posluchače výstrahy, které je dokument bude upraven.Posluchače hlasovat proti úpravy.
Veřejná metoda QuerySaveFile() Posluchače výstrahy, které soubor je uložen.Posluchači mohou
Veřejná metoda QuerySaveFile(String, tagVSQuerySaveFlags) Posluchače výstrahy, které soubor je uložen.
Veřejná metoda ReloadDocData Nové načtení dokumentu.
Chráněná metoda ReloadDocDataWorker Nové načtení dokumentu.
Veřejná metoda RenameDocData Přejmenuje dokumentu a obnoví jeho umístění v hierarchii.
Chráněná metoda ResumeFileChangeNotification Obnoví distribuce oznámení o změně dokumentu pro dokument.
Chráněná metoda Save(String) Uloží dokument.
Veřejná metoda Save(String, Int32, UInt32) Uloží dokument.
Veřejná metoda SaveCompleted Uložení dokumentu upozornění posluchače.
Veřejná metoda SaveDocData Uloží dokument na určité místo.
Chráněná metoda SaveDocDataToFile Uloží dokument na určité místo.
Chráněná metoda SaveSubordinateFile Zadaný dokument, která je podřízená dokumentu, například soubor diagram uložte.
Veřejná metoda SetData Dokument se nastaví do vyrovnávací paměti.
Veřejná metoda SetDocDataDirty Nastaví dokumentu IsDirty příznak.
Veřejná metoda SetDocDataReadOnly Nastaví příznak dokumentu jen pro čtení.
Chráněná metoda SetFileName Inicializuje nebo změní název souboru dokumentu.
Chráněná metoda SetHierarchyInfo Inicializuje nebo změny dokumentu hierarchii projektu.
Veřejná metoda SetUntitledDocPath Aktuálně není implementována.
Veřejná metoda ShowSaveOptionsDlg Zobrazí dialogové okno, které může uživatel zadat další možnosti pro ukládání formátů.
Chráněná metoda SuspendFileChangeNotification Pozastaví distribuce oznámení o změně dokumentu pro dokument.
Veřejná metoda ToString Vrátí řetězec, který představuje aktuální objekt. (Zděděno z Object.)

Nahoru

Události

  Název Popis
Veřejná událost DocumentClosed Vyvolá se po zavření dokumentu.
Veřejná událost DocumentClosing Vyvolá se před uzavřením dokumentu.
Veřejná událost DocumentLoaded Vyvolá se po načtení dokumentu v okně modelování.
Veřejná událost DocumentLoading Vyvolá se před načtením dokumentu v okně modelování.
Veřejná událost DocumentReadOnlyChanged Vyvolá se příznak jen pro čtení dokumentu.
Veřejná událost DocumentReloaded Vyvolá se po dokument znovu načtena.
Veřejná událost DocumentReloading Vyvolá se před dokument znovu načtena.
Veřejná událost DocumentSaved Vyvolá se po uložení dokumentu.
Veřejná událost DocumentSaving Vyvolá se před uložením dokumentu.
Veřejná událost FileNameChanged Vyvolá se název souboru dokumentu.
Veřejná událost HierarchyChanged Vyvolá hierarchie nebo ID položky v dokumentu.

Nahoru

Explicitní implementace rozhraní

  Název Popis
Explicitní implementace rozhraníSoukromá metoda IVsFileBackup.BackupFile Vytvořte zálohu tohoto dokumentu do jednoho souboru.
Explicitní implementace rozhraníSoukromá metoda IDisposable.Dispose Uvolní všechny prostředky, které používá aktuální instance DocData třídy.
Explicitní implementace rozhraníSoukromá metoda IPersistFileFormat.GetClassID Načte ID třídy editor továrny, které byl dokument vytvořen.
Explicitní implementace rozhraníSoukromá metoda IVsFileBackup.IsBackupFileObsolete Získáte, zda je aktuální záložní soubor.

Nahoru

Poznámky

Tato třída rovněž naslouchá události pro externí dokumenty změn a můžete vyzvat uživatele k načtení dokumentu.

Bezpečný přístup z více vláken

Všechny veřejné členy static (Shared v jazyce Visual Basic) tohoto typu jsou bezpečné pro přístup z více vláken. Není zaručeno, že členy instancí jsou bezpečné pro přístup z více vláken.

Viz také

Referenční dokumentace

Microsoft.VisualStudio.Modeling.Shell – obor názvů