Поделиться через

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 Возвращает идентификатор элемента, присвоенный документ.
Защищенное свойство ServiceProvider Возвращает поставщика службы из командной оболочки.
Открытое свойство 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 Получает GUID фабрики редактора, которая создала IVsPersistDocData объект.
Открытый метод 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 Alerts, прослушиватели, что документ был закрыт.
Защищенный метод OnDocumentClosing Alerts, прослушиватели, что документ будет закрыт.
Защищенный метод OnDocumentLoaded Alerts, прослушиватели, что документ загружен.
Защищенный метод OnDocumentLoading Alerts, прослушиватели, что документ будет загружен.
Защищенный метод OnDocumentReadOnlyChanged Alerts, прослушиватели, что состояние " только для чтения " документа было изменено.
Защищенный метод OnDocumentReloaded Alerts, прослушиватели, что документ перезапущен.
Защищенный метод OnDocumentReloading Alerts, прослушиватели, что документ будет перезапущен.
Защищенный метод OnDocumentSaved Alerts, прослушиватели, что документ сохранен.
Защищенный метод OnDocumentSaving Alerts, прослушиватели, что документ будет сохранен.
Защищенный метод OnFileNameChanged Alerts, прослушиватели, что имя файла документа.
Защищенный метод OnHierarchyChanged Alerts, прослушиватели, что идентификатор элемента, присвоенный документ был изменен.
Открытый метод OnRegisterDocData Присвоит документ в иерархии файла cookie и проекта.
Открытый метод OpenView Открывает соответствующее представление для документа.
Открытый метод QueryEditFile() Alerts, прослушиватели, что документ будет редактировать.Прослушиватели могут проголосовать и правки.
Открытый метод QueryEditFile(String, tagVSQueryEditFlags) Alerts, прослушиватели, что документ будет редактировать.Прослушиватели могут проголосовать и правки.
Открытый метод QuerySaveFile() Alerts, прослушиватели, что файл должен быть сохранен.Прослушиватели могут
Открытый метод QuerySaveFile(String, tagVSQuerySaveFlags) Alerts, прослушиватели, что файл должен быть сохранен.
Открытый метод ReloadDocData Перезагрузить документ.
Защищенный метод ReloadDocDataWorker Перезагрузить документ.
Открытый метод RenameDocData Переименовывает документ и сбросить его положение в иерархии.
Защищенный метод ResumeFileChangeNotification Возобновляет распределение уведомлений документ-изменения для документа.
Защищенный метод Save(String) Сохраняет документ.
Открытый метод Save(String, Int32, UInt32) Сохраняет документ.
Открытый метод SaveCompleted Alerts, прослушиватели, что документ сохранен.
Открытый метод 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 Получает идентификатор класса фабрики редактора, который создал документ.
Явная реализация интерфейсаЗакрытый метод IVsFileBackup.IsBackupFileObsolete Получите версию файла резервной копии.

В начало страницы

Заметки

Этот класс также прослушивает события изменения для внешних документов и может перезагрузить документ запроса пользователя.

Потокобезопасность

Любые открытые члены этого типа, объявленные как static (Shared в Visual Basic), являются потокобезопасными. Потокобезопасность членов экземпляров не гарантируется.

См. также

Ссылки

Microsoft.VisualStudio.Modeling.Shell - пространство имен