通过

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 从 shell 获取服务提供程序。
公共属性 UndoManager 获取文档的 UndoManager 接口。
受保护的属性 UndoManagerIsShared 获取文档并验证多个文档是否共享同一 UndoManager 接口。
公共属性 VSUndoManager 获取 UndoManager 接口。

页首

方法

  名称 说明
受保护的方法 BackupFile 创建一个文件备份本文档。返回文档是否应重新加载，而不会丢失数据。
受保护的方法 CanSave 验证用户是否可以取消保存操作。
公共方法 Close 关闭文档。
公共方法 CreateObjRef 安全关键。创建一个对象，该对象包含生成用于与远程对象进行通信的代理所需的全部相关信息。 （继承自 MarshalByRefObject。）
公共方法 DirectoryChanged 目前尚未实现。
受保护的方法 Dispose 释放由 DocData 占用的非托管资源，还可以另外再释放托管资源。
公共方法 Equals 确定指定的对象是否等于当前对象。 （继承自 Object。）
公共方法 FilesChanged 通知客户端一个或多个文档更改。
受保护的方法 Finalize 允许对象在“垃圾回收”回收之前尝试释放资源并执行其他清理操作。 （继承自 Object。）
公共方法 FlushUndoManager 清除 UndoManager。
公共方法 GetClassID 获取创建文档编辑工厂的 GUID。
公共方法 GetCurFile 获取文档的文件名。
公共方法 GetData 从缓冲区获取文档数据。
公共方法 GetFormatList 获取列表支持文档格式。
公共方法 GetGuidEditorType 获取创建 IVsPersistDocData 编辑对象工厂的 GUID。
公共方法 GetHashCode 用作特定类型的哈希函数。 （继承自 Object。）
公共方法 GetLifetimeService 安全关键。检索控制此实例的生存期策略的当前生存期服务对象。 （继承自 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 的浅表副本。 （继承自 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 获取创建文档编辑工厂的类 ID。
显式接口实现私有方法 IVsFileBackup.IsBackupFileObsolete 获取备份文件是否是最新的。

页首

备注

此类还侦听更改事件外部文档和系统可能会提示用户重新加载文档。

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。但不保证所有实例成员都是线程安全的。

请参见

参考

Microsoft.VisualStudio.Modeling.Shell 命名空间