通过

ModelingDocData 类

表示存储中的文档。

此 API 不兼容 CLS。 

继承层次结构

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

命名空间：  Microsoft.VisualStudio.Modeling.Shell
程序集：  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0（在 Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll 中）

语法

声明
<CLSCompliantAttribute(False)> _
Public MustInherit Class ModelingDocData _
    Inherits DocData _
    Implements IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

[CLSCompliantAttribute(false)]
public abstract class ModelingDocData : DocData, 
    IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

ModelingDocData 类型公开以下成员。

构造函数

  名称 说明
受保护的方法 ModelingDocData 初始化 ModelingDocData 类的新实例。

页首

属性

  名称 说明
公共属性 Cookie 获取标识正在运行的文档表中的文档的 Cookie。 （继承自 DocData。）
公共属性 DocViews 获取为文档打开的文档视图的集合。 （继承自 DocData。）
公共属性 Encoding 获取或设置保留文档的编码。 （继承自 DocData。）
公共属性 ErrorListProvider 获取文档的错误列表提供程序。
公共属性 FileName 获取文档的文件名称。 （继承自 DocData。）
受保护的属性 FormatList 获取格式的列表。 （继承自 DocData。）
公共属性 HasErrorListItems 获取错误列表并验证文档的错误和警告是否显示在 " 错误列表 " 窗口中。
公共属性 Hierarchy 获取文件所属的项目层次结构。 （继承自 DocData。）
受保护的属性 InLoad 获取文档并验证它是否正在被加载到建模窗口。
受保护的属性 InReload 获取文档并验证它是否正在被重加载到建模窗口。
受保护的属性 IsBackupFileObsolete （继承自 DocData。）
公共属性 IsLoaded 获取一个文档并验证它是否已经被加载。 （继承自 DocData。）
公共属性 ItemId 获取被分配给文档的项 ID。 （继承自 DocData。）
公共属性 ModelingDocStore 获取分配到文档的建模设计器存储。
受保护的属性 PartitionMapper
受保护的属性 RelatedDocList
公共属性 RootElement 获取该文档中的根元素。
受保护的属性 SerializedModel
受保护的属性 ServiceProvider 从shell获取服务的提供者。 （继承自 DocData。）
公共属性 Store 获取该文档被分配到的建模设计器存储。
公共属性 UndoManager 获取 UndoManager 类，可以使用撤消和重做操作在建模设计师存储。 （重写 DocData.UndoManager。）
受保护的属性 UndoManagerIsShared 获取 UndoManager 类并验证它是否在文件中共享。 （重写 DocData.UndoManagerIsShared。）
公共属性 VSUndoManager 获取 UndoManager 接口。 （继承自 DocData。）

页首

方法

  名称 说明
公共方法 AddErrorListItem 添加一个可以与文档一起使用的错误或警告消息。
受保护的方法 BackupFile 创建此文档的单文件备份。在不丢失数据的情况下，返回是否文档应重载 （继承自 DocData。）
受保护的方法 CanSave 验证用户是否可以取消保存操作。 （继承自 DocData。）
受保护的方法 CleanupStores 该文件重新导入内存之前，清除建模设计器储存库。
公共方法 ClearErrorListItems 从错误列表窗口清除错误和警告消息。
公共方法 Close 关闭文档。 （继承自 DocData。）
受保护的方法 CreateModelingDocStore 为建模设计器储存库创建文档。
受保护的方法 CreateObject 创建一个对象
公共方法 CreateObjRef 安全关键。创建一个对象，该对象包含生成用于与远程对象进行通信的代理所需的全部相关信息。 （继承自 MarshalByRefObject。）
受保护的方法 CreatePartitionMapper 当重建 ElementGroupPrototypes 时，工厂方法创建分区映射，负责将元素映射到 ModelingDocData 的存储区的正确分区。
受保护的方法 CreateStore 创建建模储存库。
受保护的方法 CreateSubordinateDocData 创建一个从属文档数据实例
公共方法 DirectoryChanged 目前尚未实现。 （继承自 DocData。）
受保护的方法 Dispose 释放由 ModelingDocData 占用的非托管资源，还可以另外再释放托管资源。 （重写 DocData.Dispose(Boolean)。）
公共方法 Equals 确定指定的对象是否等于当前对象。 （继承自 Object。）
公共方法 FilesChanged 向客户端发出一个或更多的文档已更改的通知。 （继承自 DocData。）
受保护的方法 Finalize 允许对象在“垃圾回收”回收之前尝试释放资源并执行其他清理操作。 （继承自 Object。）
公共方法 FlushUndoManager 清除存储区的 UndoManager 类。 （重写 DocData.FlushUndoManager()。）
公共方法 GetAllElementsForValidation 获取供验证的所有元素。基实现将返回此 DocData 的存储区中的所有元素。
公共方法 GetClassID 获取生成该文档的编辑器工厂的 GUID。 （继承自 DocData。）
公共方法 GetCurFile 获取文档的文件名称。 （继承自 DocData。）
公共方法 GetData 从缓冲区获取文档数据。 （继承自 DocData。）
受保护的方法 GetDomainModels 获取加载到存储中的类型集合。
公共方法 GetFormatList 获取支持的文档格式列表。 （继承自 DocData。）
公共方法 GetGuidEditorType 获取返回创建IVsPersistDocData 对象的编辑器工厂的 GUID。 （继承自 DocData。）
公共方法 GetHashCode 作为默认哈希函数。 （继承自 Object。）
公共方法 GetLifetimeService 安全关键。检索控制此实例的生存期策略的当前生存期服务对象。 （继承自 MarshalByRefObject。）
公共方法 GetRelatedSaveTreeItems IVsHasRelatedSaveItems 的标准实现。使用带此实例的 IRelatedDocList 接口注册另一个 DocData，则它可能会以 RelatedSaveTreeItem 的形式返回。
公共方法 GetService 向存储区提供本地服务并且存储区的用户服务提供程序 （重写 DocData.GetService(Type)。）
公共方法 GetTextBuffer 加载此序列化模型至新的缓冲区。
公共方法 GetType 获取当前实例的 Type。 （继承自 Object。）
受保护的方法 HandleLoadDocDataException 管理当文档在加载时引发的任何异常。 （继承自 DocData。）
受保护的方法 HandleSaveDocDataException 管理当文档在保存时引发的任何异常。 （继承自 DocData。）
公共方法 HideErrorListItems 隐藏错误列表窗口中所有错误和警告消息。
公共方法 IgnoreFileChanges 确定是否应忽略文档的更改。 （继承自 DocData。）
公共方法 Initialize() 初始化 ModelingDocData 类。
公共方法 Initialize(Store) 初始化文档的建模设计器储存库。
公共方法 InitializeLifetimeService 安全关键。获取控制此实例的生存期策略的生存期服务对象。 （继承自 MarshalByRefObject。）
公共方法 InitNew 初始化文档。 （继承自 DocData。）
公共方法 IsDirty 验证自最近保存操作以来文档是否已发生更改。 （继承自 DocData。）
公共方法 IsDocDataDirty 验证自最近保存操作以来文档是否已发生更改。 （继承自 DocData。）
公共方法 IsDocDataReadOnly 验证文档是否为只读。 （继承自 DocData。）
公共方法 IsDocDataReloadable 验证是否可重载文档。 （继承自 DocData。）
受保护的方法 IsFlushUndoStackRequiredOnLoad 重写此方法以指定如果刷新撤消堆栈在加载（打开或创建）docdata 后。
受保护的方法 Load(String, Boolean) 将文档加载到内存中。 （继承自 DocData。）
公共方法 Load(String, UInt32, Int32) 将文档加载到内存中。 （继承自 DocData。）
公共方法 LoadDocData(String) 用此文档的文件名加载此文档。 （继承自 DocData。）
受保护的方法 LoadDocData(String, Boolean) 加载有指定文件名的文档。 （重写 DocData.LoadDocData(String, Boolean)。）
公共方法 LockTextBuffer 未实现。
公共方法 MarkDocumentChangedForBackup 标记已更改的文档，因此新的备份应创建。 （继承自 DocData。）
受保护的方法 MemberwiseClone() 创建当前 Object 的浅表副本。 （继承自 Object。）
受保护的方法 MemberwiseClone(Boolean) 创建当前 MarshalByRefObject 对象的浅表副本。 （继承自 MarshalByRefObject。）
受保护的方法 OnDocumentClosed 在关闭文档时调用。默认行为可清除列表内容中的错误。 （重写 DocData.OnDocumentClosed(EventArgs)。）
受保护的方法 OnDocumentClosing 将关闭警报侦听器文档。 （继承自 DocData。）
受保护的方法 OnDocumentLoaded 加载了警报侦听器文档。 （继承自 DocData。）
受保护的方法 OnDocumentLoading 将加载警报侦听器文档。 （继承自 DocData。）
受保护的方法 OnDocumentReadOnlyChanged 更改了警报侦听器文档的只读状态。 （继承自 DocData。）
受保护的方法 OnDocumentReloaded 重新加载了警报侦听器文档。 （继承自 DocData。）
受保护的方法 OnDocumentReloading 将重新加载警报侦听器文档。 （继承自 DocData。）
受保护的方法 OnDocumentSaved 保存了警报侦听器文档。 （继承自 DocData。）
受保护的方法 OnDocumentSaving 将保存警报侦听器文档。 （继承自 DocData。）
受保护的方法 OnFileNameChanged 更改了警报侦听器文档的文件名。 （继承自 DocData。）
受保护的方法 OnHierarchyChanged 添加或重命名一个文档时调用。 （重写 DocData.OnHierarchyChanged(EventArgs)。）
公共方法 OnRegisterDocData 将文档分配到 cookie 和项目层次。 （继承自 DocData。）
公共方法 OpenView 打开此文档的指定视图。 （重写 DocData.OpenView(Guid, Object)。）
公共方法 QueryEditFile() 警告侦听器文档将要被编辑。侦听器可以投票反对此编辑。 （继承自 DocData。）
公共方法 QueryEditFile(String, tagVSQueryEditFlags) 警告侦听器文档将要被编辑。侦听器可以投票反对此编辑。 （继承自 DocData。）
公共方法 QuerySaveFile() 警告侦听器文件将要被保存。侦听器可以 （继承自 DocData。）
公共方法 QuerySaveFile(String, tagVSQuerySaveFlags) 警告侦听器文件将要被保存。 （继承自 DocData。）
公共方法 ReloadDocData 重新加载文档 （继承自 DocData。）
受保护的方法 ReloadDocDataWorker 重新加载文档 （继承自 DocData。）
公共方法 RenameDocData 重命名文档并在层次结构中重置其位置。 （继承自 DocData。）
公共方法 ResumeErrorListRefresh 每次错误或警告对文档添加时刷新错误列表窗口。
受保护的方法 ResumeFileChangeNotification 恢复文档的文挡更改通知的分布。 （继承自 DocData。）
受保护的方法 Save(String) 保存文档。 （继承自 DocData。）
公共方法 Save(String, Int32, UInt32) 保存文档。 （继承自 DocData。）
公共方法 SaveCompleted 保存了警报侦听器文档。 （继承自 DocData。）
公共方法 SaveDocData 将文档保存到指定的位置。 （继承自 DocData。）
受保护的方法 SaveDocDataToFile 将文档保存到指定的位置。 （继承自 DocData。）
受保护的方法 SaveSubordinateFile 保存从属于此文档的指定的文件，如关系图文件。 （继承自 DocData。）
公共方法 SetData 设置文档到缓冲区。 （继承自 DocData。）
公共方法 SetDocDataDirty 设置文档的 IsDirty 标识。 （继承自 DocData。）
公共方法 SetDocDataReadOnly 设置文档的只读标识。 （继承自 DocData。）
受保护的方法 SetFileName 初始化或更改文档的文件名。 （继承自 DocData。）
受保护的方法 SetHierarchyInfo 初始化或更改文档的项目层次。 （继承自 DocData。）
受保护的方法 SetRootElement 设置根元素。
公共方法 SetTextBuffer 未实现。
公共方法 SetUntitledDocPath 当前未实现。 （继承自 DocData。）
公共方法 ShowErrorListItems 显示错误列表窗口中所有错误和警告消息。
公共方法 ShowSaveOptionsDlg 显示用户可以为保存格式指定其他选项的对话框。 （继承自 DocData。）
公共方法 SupportsLogicalView 验证文档是否支持指定视图。
公共方法 SuspendErrorListRefresh 防止错误列表窗口刷新。
受保护的方法 SuspendFileChangeNotification 挂起文档的文件更改通知的分布。 （继承自 DocData。）
公共方法 ToString 返回表示当前对象的字符串。 （继承自 Object。）

页首

事件

  名称 说明
公共事件 DocumentClosed 关闭文档后发生。 （继承自 DocData。）
公共事件 DocumentClosing 关闭文档前发生。 （继承自 DocData。）
公共事件 DocumentLoaded 在文档已被加载至模型窗口后发生。 （继承自 DocData。）
公共事件 DocumentLoading 在文档加载至模型窗口前发生。 （继承自 DocData。）
公共事件 DocumentReadOnlyChanged 当文档的只读标志更改时发生。 （继承自 DocData。）
公共事件 DocumentReloaded 重新加载文档后发生。 （继承自 DocData。）
公共事件 DocumentReloading 在重新加载文档之前发生。 （继承自 DocData。）
公共事件 DocumentSaved 在保存文档后发生。 （继承自 DocData。）
公共事件 DocumentSaving 在保存文档之前发生。 （继承自 DocData。）
公共事件 FileNameChanged 当文档的文件名更改时发生。 （继承自 DocData。）
公共事件 HierarchyChanged 当文档的级别或 项 ID 更改时发生。 （继承自 DocData。）

页首

显式接口实现  

  名称 说明
显式接口实现私有方法 IVsFileBackup.BackupFile 创建此文档的单文件备份。 （继承自 DocData。）
显式接口实现私有方法 IDisposable.Dispose 释放由 DocData 类的当前实例占用的所有资源。 （继承自 DocData。）
显式接口实现私有方法 IPersistFileFormat.GetClassID 获取创建文档的编辑器工厂的类 ID。 （继承自 DocData。）
显式接口实现私有方法 IVsFileBackup.IsBackupFileObsolete 获取备份文件是否被更新。 （继承自 DocData。）

页首

备注

内存中文档由内存存储返回。

线程安全

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

请参阅

参考

Microsoft.VisualStudio.Modeling.Shell 命名空间