DocData 類別

在衍生類別中覆寫時，表示記憶體中的文件。

此應用程式開發介面不符合 CLS 標準。 

繼承階層架構

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

命名空間：  Microsoft.VisualStudio.Modeling.Shell
組件：  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (在 Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll 中)

語法

'宣告
<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

DocData 類型會公開下列成員。

建構函式

	名稱	描述
	DocData	初始化 DocData 類別的新執行個體。

回頁首

屬性

	名稱	描述
	Cookie	取得用來識別執行中文件資料表中之文件的 cookie。
	DocViews	取得對此文件開啟的文件檢視集合。
	Encoding	取得或設定保存文件的編碼方式。
	FileName	取得文件的檔案名稱。
	FormatList	取得格式的清單。
	Hierarchy	取得文件所屬的專案階層架構。
	IsBackupFileObsolete
	IsLoaded	取得文件，並確認它是否已載入。
	ItemId	取得指派給文件的項目 ID。
	ServiceProvider	從殼層取得服務提供者。
	UndoManager	取得文件的 UndoManager 介面。
	UndoManagerIsShared	取得文件，並確認多份文件是否共用相同 UndoManager 介面。
	VSUndoManager	取得 UndoManager 介面。

回頁首

方法

	名稱	描述
	BackupFile	建立這份文件的單一檔案備份。傳回是否應重新載入文件而不遺失資料。
	CanSave	確認使用者是否可以取消儲存作業。
	Close	關閉文件。
	CreateObjRef	安全性關鍵。建立包含所有相關資訊的物件，這些資訊是產生用來與遠端物件通訊的所需 Proxy。 (繼承自 MarshalByRefObject)。
	DirectoryChanged	目前未實作。
	Dispose	釋放 DocData 所使用的 Unmanaged 資源，並選擇性釋放 Managed 資源。
	Equals	判斷指定的物件是否等於目前物件。 (繼承自 Object)。
	FilesChanged	告知用戶端，一份或多份文件已變更。
	Finalize	允許物件在記憶體回收進行回收之前，嘗試釋放資源並執行其他清除作業。 (繼承自 Object)。
	FlushUndoManager	清除 UndoManager。
	GetClassID	取得建立文件之 Editor Factory 的 GUID。
	GetCurFile	取得文件的檔案名稱。
	GetData	取得緩衝區中的文件資料。
	GetFormatList	取得支援的文件格式的清單。
	GetGuidEditorType	取得建立 IVsPersistDocData 物件之編輯器 Factory 的 GUID。
	GetHashCode	做為預設雜湊函式。 (繼承自 Object)。
	GetLifetimeService	安全性關鍵。擷取控制這個執行個體存留期 (Lifetime) 原則的目前存留期服務物件。 (繼承自 MarshalByRefObject)。
	GetService	傳回所要求的服務。
	GetType	取得目前執行個體的 Type。 (繼承自 Object)。
	HandleLoadDocDataException	管理文件載入時所擲回的任何例外狀況。
	HandleSaveDocDataException	管理文件儲存時所擲回的任何例外狀況。
	IgnoreFileChanges	判斷是否應忽略文件的變更。
	InitializeLifetimeService	安全性關鍵。取得存留期服務物件來控制這個執行個體的存留期原則。 (繼承自 MarshalByRefObject)。
	InitNew	初始化文件。
	IsDirty	確認自上次儲存作業之後，文件是否有變更。
	IsDocDataDirty	確認自上次儲存作業之後，文件是否有變更。
	IsDocDataReadOnly	驗證文件是否為唯讀。
	IsDocDataReloadable	確認文件是否可以重新載入。
	Load(String, Boolean)	將文件載入記憶體。
	Load(String, UInt32, Int32)	將文件載入記憶體。
	LoadDocData(String)	藉由使用其檔名中載入文件。
	LoadDocData(String, Boolean)	藉由使用其檔名中載入文件。
	MarkDocumentChangedForBackup	標記文件已變更，因此應該建立新的備份
	MemberwiseClone()	建立目前 Object 的淺層複本 (Shallow Copy)。 (繼承自 Object)。
	MemberwiseClone(Boolean)	建立目前 MarshalByRefObject 物件的淺層複本。 (繼承自 MarshalByRefObject)。
	OnDocumentClosed	通知接聽程式，文件已關閉。
	OnDocumentClosing	通知接聽程式，文件即將關閉。
	OnDocumentLoaded	通知接聽程式，文件已載入。
	OnDocumentLoading	通知接聽程式，文件即將載入。
	OnDocumentReadOnlyChanged	通知接聽程式，文件的唯讀狀態已變更。
	OnDocumentReloaded	通知接聽程式，文件已重新載入。
	OnDocumentReloading	通知接聽程式，文件即將重新載入。
	OnDocumentSaved	通知接聽程式，文件已儲存。
	OnDocumentSaving	通知接聽程式，文件即將儲存。
	OnFileNameChanged	通知接聽程式，文件的檔案名稱已變更。
	OnHierarchyChanged	通知接聽程式，指派給文件的項目 ID 已變更。
	OnRegisterDocData	將文件指派給 Cookie 和專案階層架構。
	OpenView	開啟文件的特定檢視。
	QueryEditFile()	通知接聽程式已準備要編輯文件。接聽程式可以投票反對編輯。
	QueryEditFile(String, tagVSQueryEditFlags)	通知接聽程式已準備要編輯文件。接聽程式可以投票反對編輯。
	QuerySaveFile()	警示接聽程式，告知即將儲存檔案。接聽程式可以
	QuerySaveFile(String, tagVSQuerySaveFlags)	警示接聽程式，告知即將儲存檔案。
	ReloadDocData	重新載入文件。
	ReloadDocDataWorker	重新載入文件。
	RenameDocData	重新命名文件，並重設文件在階層架構中的位置。
	ResumeFileChangeNotification	繼續散發文件 - 文件的變更通知。
	Save(String)	儲存文件。
	Save(String, Int32, UInt32)	儲存文件。
	SaveCompleted	通知接聽程式，文件已儲存。
	SaveDocData	將文件儲存至特定位置。
	SaveDocDataToFile	將文件儲存至特定位置。
	SaveSubordinateFile	儲存附屬於此文件的指定文件，例如圖表檔案。
	SetData	設定緩衝區的文件。
	SetDocDataDirty	設定文件的IsDirty旗標。
	SetDocDataReadOnly	設定文件的唯讀旗標。
	SetFileName	初始化或變更文件的檔案名稱。
	SetHierarchyInfo	初始化或變更文件的專案階層。
	SetUntitledDocPath	目前未實作。
	ShowSaveOptionsDlg	顯示對話方塊，使用者可以從中指定其他儲存格式選項。
	SuspendFileChangeNotification	暫止散發文件 - 文件的變更通知。
	ToString	傳回表示目前物件的字串。 (繼承自 Object)。

回頁首

事件

	名稱	描述
	DocumentClosed	在關閉表單之後發生。
	DocumentClosing	在關閉文件之前發生。
	DocumentLoaded	在模型視窗中載入文件之後發生。
	DocumentLoading	在模型視窗中載入文件之前發生。
	DocumentReadOnlyChanged	當文件的唯讀旗標變更時發生。
	DocumentReloaded	在重新載入文件之後發生。
	DocumentReloading	在重新載入文件之前發生。
	DocumentSaved	在儲存文件之後發生。
	DocumentSaving	在儲存文件之前發生。
	FileNameChanged	文件的檔案名稱變更時發生。
	HierarchyChanged	當文件的階層或項目 ID 變更時發生。

回頁首

明確介面實作

	名稱	描述
	IVsFileBackup.BackupFile	建立這份文件的單一檔案備份。
	IDisposable.Dispose	將 DocData 類別目前的執行個體所使用的資源全部釋出。
	IPersistFileFormat.GetClassID	取得建立文件之 Editor Factory 的類別 ID。
	IVsFileBackup.IsBackupFileObsolete	取得備份檔案是否為最新狀態。

回頁首

備註

這個類別也接聽變更事件外部資料，而且可以提示使用者重新載入文件。

執行緒安全

這個類型的任何 Public static (在 Visual Basic 中為 Shared) 成員都是安全執行緒。不保證任何執行個體成員是安全執行緒。

請參閱

參考

Microsoft.VisualStudio.Modeling.Shell 命名空間