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.11.0(在 Microsoft.VisualStudio.Modeling.Sdk.Shell.11.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 | 创建分区制图员的工厂方法负责将元素映射到此 ModelingDocData 拥有的存储正确的分区,当 ElementGroupPrototypes 重新组成。 | |
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 | 服务存储服务提供程序的 local service 到存储和用户 (重写 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) 成员都是线程安全的。但不保证所有实例成员都是线程安全的。