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 | |
---|---|---|
DocData | Vytvoří novou instanci třídy DocData. |
Nahoru
Vlastnosti
Název | Popis | |
---|---|---|
Cookie | Získává cookie, který identifikuje dokumentu v tabulce s dokumenty. | |
DocViews | Získá kolekce zobrazení dokumentu, které jsou otevřené pro dokument. | |
Encoding | Získá nebo nastaví kódování dokumentu přetrvává. | |
FileName | Získá název souboru dokumentu. | |
FormatList | Získá seznam formátů. | |
Hierarchy | Získá hierarchii projektu, k němuž patří dokument. | |
IsBackupFileObsolete | ||
IsLoaded | Dokument obdrží a ověří, zda je načten. | |
ItemId | Načte ID položky, která je přiřazena k dokumentu. | |
ServiceProvider | Poskytovatel metadat získává z prostředí. | |
UndoManager | Získává UndoManager rozhraní pro dokument. | |
UndoManagerIsShared | Získá dokumentu a ověří, zda je více než jeden dokument sdílení stejné UndoManager rozhraní. | |
VSUndoManager | Získává UndoManager rozhraní. |
Nahoru
Metody
Název | Popis | |
---|---|---|
BackupFile | Vytvořte zálohu tohoto dokumentu do jednoho souboru.Vrátí se, zda dokument má re-load bez ztráty dat.. | |
CanSave | Ověří, zda uživatel může zrušit ukládání 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 zadaný objekt je rovno aktuální objekt. (Zděděno z Object.) | |
FilesChanged | Upozorní klienty, že změněn jeden nebo více dokumentů. | |
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.) | |
FlushUndoManager | Vymaže UndoManager. | |
GetClassID | Získá identifikátor GUID editor výroby, 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 | Identifikátor GUID factory editor, který vytvořili získává IVsPersistDocData objektu. | |
GetHashCode | Slouží jako funkci hash u určitého typu. (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ány, když byl načítání dokumentu. | |
HandleSaveDocDataException | Spravuje všechny výjimky, které byly vyvolány při ukládání dokumentu. | |
IgnoreFileChanges | Určuje, zda budou ignorovány změny 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 poslední operaci uložení. | |
IsDocDataDirty | Ověří, zda dokument byl změněn poslední operaci uložení. | |
IsDocDataReadOnly | Ověří, zda dokument je jen pro čtení. | |
IsDocDataReloadable | Ověří, zda lze dokument znovu načteny. | |
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 změnil, a proto by měl být vytvořen nový zálohování | |
MemberwiseClone() | Vytvoří kopii 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 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 | Znovu vložený dokument upozornění posluchače. | |
OnDocumentSaved | Uložení dokumentu upozornění posluchače. | |
OnDocumentSaving | Upozornění posluchače, že dokument uložit. | |
OnFileNameChanged | Upozornění posluchače, že byl změněn název souboru dokumentu. | |
OnHierarchyChanged | Upozornění posluchače, že došlo ke změně ID položky, která je přiřazena k dokumentu. | |
OnRegisterDocData | Přiřadí cookie a projektu hierarchii dokumentu. | |
OpenView | Otevře zobrazení určitého dokumentu. | |
QueryEditFile() | Posluchače výstrahy, které je dokument bude upraven.Posluchače hlasovat proti úpravy. | |
QueryEditFile(String, tagVSQueryEditFlags) | Posluchače výstrahy, které je dokument bude upraven.Posluchače hlasovat proti úpravy. | |
QuerySaveFile() | Posluchače výstrahy, které soubor je uložen.Posluchači mohou | |
QuerySaveFile(String, tagVSQuerySaveFlags) | Posluchače výstrahy, které soubor je uložen. | |
ReloadDocData | Nové načtení dokumentu. | |
ReloadDocDataWorker | Nové načtení dokumentu. | |
RenameDocData | Přejmenuje dokumentu a obnoví jeho umístění v hierarchii. | |
ResumeFileChangeNotification | Obnoví distribuce oznámení o změně dokumentu pro dokument. | |
Save(String) | Uloží dokument. | |
Save(String, Int32, UInt32) | Uloží dokument. | |
SaveCompleted | Uložení dokumentu upozornění posluchače. | |
SaveDocData | Uloží dokument na určité místo. | |
SaveDocDataToFile | Uloží dokument na určité místo. | |
SaveSubordinateFile | Zadaný dokument, která je podřízená dokumentu, například soubor diagram uložte. | |
SetData | Dokument se nastaví do vyrovnávací paměti. | |
SetDocDataDirty | Nastaví dokumentu IsDirty příznak. | |
SetDocDataReadOnly | Nastaví příznak dokumentu jen pro čtení. | |
SetFileName | Inicializuje nebo změní název souboru dokumentu. | |
SetHierarchyInfo | Inicializuje nebo změny dokumentu hierarchii projektu. | |
SetUntitledDocPath | Aktuálně není implementována. | |
ShowSaveOptionsDlg | Zobrazí dialogové okno, které může uživatel zadat další možnosti pro ukládání formátů. | |
SuspendFileChangeNotification | Pozastaví distribuce oznámení o změně dokumentu pro dokument. | |
ToString | Vrátí ř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 uzavřením dokumentu. | |
DocumentLoaded | Vyvolá se po načtení dokumentu v okně modelování. | |
DocumentLoading | Vyvolá se před načtením dokumentu v okně modelování. | |
DocumentReadOnlyChanged | Vyvolá se příznak jen pro čtení dokumentu. | |
DocumentReloaded | Vyvolá se po dokument znovu načtena. | |
DocumentReloading | Vyvolá se před dokument znovu načtena. | |
DocumentSaved | Vyvolá se po uložení dokumentu. | |
DocumentSaving | Vyvolá se před uložením dokumentu. | |
FileNameChanged | Vyvolá se název souboru dokumentu. | |
HierarchyChanged | Vyvolá 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, které používá aktuální instance DocData třídy. | |
IPersistFileFormat.GetClassID | Načte ID třídy editor továrny, které byl dokument vytvořen. | |
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.