DocData 類別

在衍生類別中覆寫時，則其所代表記憶體中的文件。

此 API 不符合 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.11.0 (在 Microsoft.VisualStudio.Modeling.Sdk.Shell.11.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	取得建立文件編輯器工廠的 GUID。
	GetCurFile	取得文件的檔名。
	GetData	取得緩衝區中的文件資料。
	GetFormatList	取得支援的文件格式的清單。
	GetGuidEditorType	取得編輯器處理站所建立的 GUID IVsPersistDocData物件。
	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	系統會通知的接聽程式係授與文件項目識別碼已經變更。
	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	當文件的階層或項目識別碼變更時發生。

回頁首

明確介面實作

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

回頁首

備註

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

執行緒安全

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

請參閱

參考

Microsoft.VisualStudio.Modeling.Shell 命名空間