通过

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.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 从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 命名空间