DocData – třída

Článek
06/02/2014

Při přepsání v odvozené třídě 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.12.0 (v Microsoft.VisualStudio.Modeling.Sdk.Shell.12.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
	DocData	Vytvoří novou instanci třídy DocData.

Nahoru

Vlastnosti

	Název	Popis
	Cookie	Získá soubor cookie, který identifikuje dokument v tabulce spuštěné dokumenty.
	DocViews	Získá kolekce zobrazení dokumentů, které jsou otevřené pro dokument.
	Encoding	Získá nebo nastaví kódování, které ukládá dokument.
	FileName	Získá název souboru dokumentu.
	FormatList	Získá seznam formátů.
	Hierarchy	Získá hierarchii projektu, ke kterému patří dokumentu.
	IsBackupFileObsolete
	IsLoaded	Získá dokument a ověří, zda je načten.
	ItemId	Získá ID položky, který je přiřazen k dokumentu.
	ServiceProvider	Získá poskytovatel metadat z prostředí.
	UndoManager	Získá UndoManager rozhraní pro dokument.
	UndoManagerIsShared	Získá dokument a ověří, zda více než jeden dokument sdílí stejné UndoManager rozhraní.
	VSUndoManager	Získá UndoManager rozhraní.

Nahoru

Metody

	Název	Popis
	BackupFile	Vytvořte zálohu tohoto dokumentu do jednoho souboru.Vrátí, zda se očekává bez ztráty dat načtení dokumentu.
	CanSave	Ověří, zda uživatel může zrušit uložení operace.
	Close	Zavře dokument.
	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.)
	DirectoryChanged	Není aktuálně implementováno.
	Dispose	Uvolní nespravované prostředky používané DocData a volitelně uvolní spravované prostředky.
	Equals	Určuje, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno z Object.)
	FilesChanged	Upozorňuje klienty, že změnit jeden nebo více dokumentů.
	Finalize	Umožňuje objektu k pokusu uvolnit prostředky a provádět další operace vyčištění před je zažádáno systémem uvolňování paměti. (Zděděno z Object.)
	FlushUndoManager	Vymaže UndoManager.
	GetClassID	Získá identifikátor GUID editor továrny, které byl dokument vytvořen.
	GetCurFile	Získá název souboru dokumentu.
	GetData	Získává data dokumentu z vyrovnávací paměti.
	GetFormatList	Získá seznam podporované formáty dokumentů.
	GetGuidEditorType	Získá identifikátor GUID editor výroby, kterou vytvořili IVsPersistDocData objektu.
	GetHashCode	Slouží jako výchozí funkce hash. (Zděděno z Object.)
	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.)
	GetService	Vrátí požadované služby.
	GetType	Získá Type aktuální instance. (Zděděno z Object.)
	HandleLoadDocDataException	Spravuje všechny výjimky, které byly vyvolána v případě, že bylo načítání dokumentu.
	HandleSaveDocDataException	Spravuje všechny výjimky, které byly vyvolány při ukládání dokumentu.
	IgnoreFileChanges	Určuje, zda je ignorována změny v dokumentu.
	InitializeLifetimeService	Kritické pro zabezpečení Získá objektu životnost služby řízení zásad platnosti pro tuto instanci. (Zděděno z MarshalByRefObject.)
	InitNew	Inicializuje dokumentu.
	IsDirty	Ověří, zda dokument byl změněn od posledního uložení operace.
	IsDocDataDirty	Ověří, zda dokument byl změněn od posledního uložení operace.
	IsDocDataReadOnly	Ověří, zda je dokument jen pro čtení.
	IsDocDataReloadable	Ověří, zda mohou dokument znovu načíst.
	Load(String, Boolean)	Dokument se načte do paměti.
	Load(String, UInt32, Int32)	Dokument se načte do paměti.
	LoadDocData(String)	Načte dokument pomocí názvu souboru.
	LoadDocData(String, Boolean)	Načte dokument pomocí názvu souboru.
	MarkDocumentChangedForBackup	Značka, která dokument byl změněn a proto by se měly vytvořit novou zálohu
	MemberwiseClone()	Vytvoří mělká kopie aktuálního Object. (Zděděno z Object.)
	MemberwiseClone(Boolean)	Vytvoří kopii aktuální MarshalByRefObject objektu. (Zděděno z MarshalByRefObject.)
	OnDocumentClosed	Upozornění posluchače, že dokument byl uzavřen.
	OnDocumentClosing	Upozornění posluchače, že dokument bude uzavřen.
	OnDocumentLoaded	Upozornění posluchače, že je dokument načten.
	OnDocumentLoading	Upozornění posluchače, že dokument bude načten.
	OnDocumentReadOnlyChanged	Upozornění posluchače, aby se změnil stav jen pro čtení dokumentu.
	OnDocumentReloaded	Upozornění posluchače, aby byla znovu vložený dokument.
	OnDocumentReloading	Upozornění posluchače znovu vložený dokument.
	OnDocumentSaved	Upozornění posluchače, že dokument byl uložen.
	OnDocumentSaving	Upozornění posluchače, že dokument bude uložen.
	OnFileNameChanged	Upozornění posluchače, že došlo ke změně názvu souboru dokumentu.
	OnHierarchyChanged	Upozornění posluchače, že došlo ke změně ID položky, který je přiřazen k dokumentu.
	OnRegisterDocData	Přiřadí dokumentu hierarchii projektu a souborů cookie.
	OpenView	Otevře zobrazení určitého dokumentu.
	QueryEditFile()	Upozorní moduly pro naslouchání, že dokument bude upravován.Posluchači mohou hlasovat proti úpravy.
	QueryEditFile(String, tagVSQueryEditFlags)	Upozorní moduly pro naslouchání, že dokument bude upravován.Posluchači mohou hlasovat proti úpravy.
	QuerySaveFile()	Upozorní moduly pro naslouchání, že soubor bude uložen.Posluchači mohou
	QuerySaveFile(String, tagVSQuerySaveFlags)	Upozorní moduly pro naslouchání, že soubor bude uložen.
	ReloadDocData	Nové načtení dokumentu.
	ReloadDocDataWorker	Nové načtení dokumentu.
	RenameDocData	Přejmenuje dokumentu a nastaví jeho umístění v hierarchii.
	ResumeFileChangeNotification	Obnoví distribuci oznámení o změně dokumentu pro dokument.
	Save(String)	Uloží dokument.
	Save(String, Int32, UInt32)	Uloží dokument.
	SaveCompleted	Upozornění posluchače, že dokument byl uložen.
	SaveDocData	Uloží dokument do určitého umístění.
	SaveDocDataToFile	Uloží dokument do určitého umístění.
	SaveSubordinateFile	Uložte zadaný dokument, který je k tomuto dokumentu, například soubor diagramu podřízeného.
	SetData	Nastaví dokument do vyrovnávací paměti.
	SetDocDataDirty	Nastaví v dokumentu IsDirty příznak.
	SetDocDataReadOnly	Nastaví příznak jen pro čtení dokumentu.
	SetFileName	Inicializuje nebo změně názvu souboru dokumentu.
	SetHierarchyInfo	Inicializuje nebo změny dokumentu hierarchii projektu.
	SetUntitledDocPath	Aktuálně není implementováno.
	ShowSaveOptionsDlg	Zobrazí dialogové okno, ze kterého může uživatel zadat další možnosti pro ukládání formátů.
	SuspendFileChangeNotification	Pozastavení distribuce oznámení o změně dokumentu pro dokument.
	ToString	Vrací řetězec, který představuje aktuální objekt. (Zděděno z Object.)

Nahoru

Události

	Název	Popis
	DocumentClosed	Vyvolá se po zavření dokumentu.
	DocumentClosing	Vyvolá se před zavřením dokumentu.
	DocumentLoaded	Vyvolá se po načtení dokumentu v okně modelování.
	DocumentLoading	Vyvolá se před načtením dokladu v okně modelování.
	DocumentReadOnlyChanged	Vyvolá se při změně příznak jen pro čtení dokumentu.
	DocumentReloaded	Vyvolá se po opětovném načtení dokumentu.
	DocumentReloading	Nastane předtím, než je znovu vložený dokument.
	DocumentSaved	Vyvolá se po uložení dokumentu.
	DocumentSaving	Vyvolá se před uložením dokumentu.
	FileNameChanged	Vyvolá se při změně názvu souboru dokumentu.
	HierarchyChanged	Vyvolá se při hierarchie nebo ID položky v dokumentu.

Nahoru

Explicitní implementace rozhraní

	Název	Popis
	IVsFileBackup.BackupFile	Vytvořte zálohu tohoto dokumentu do jednoho souboru.
	IDisposable.Dispose	Uvolní všechny prostředky používané aktuální instance DocData třídy.
	IPersistFileFormat.GetClassID	Získá Identifikátor třídy factory editoru, které byl dokument vytvořen.
	IVsFileBackup.IsBackupFileObsolete	Získáte, zda je aktuální záložní soubor.

Nahoru

Poznámky

Tato třída také 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ů

Sdílet prostřednictvím

DocData – třída

Hierarchie dědičnosti

Syntaxe

Konstruktory

Vlastnosti

Metody

Události

Explicitní implementace rozhraní

Poznámky

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

Viz také

Referenční dokumentace

Další materiály