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

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 Получает идентификатор элемента, присвоенный документу.
Защищенное свойство 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 Сообщает прослушивателям, что документ закрыт.
Защищенный метод OnDocumentClosing Сообщает прослушивателям, что документ будет закрыт.
Защищенный метод OnDocumentLoaded Сообщает прослушивателям, что документ загружен.
Защищенный метод OnDocumentLoading Сообщает прослушивателям, что документ будет загружен.
Защищенный метод OnDocumentReadOnlyChanged Сообщает прослушивателям, что состояние "только для чтения" документа изменилось.
Защищенный метод OnDocumentReloaded Сообщает прослушивателям, что документ перезагружен.
Защищенный метод OnDocumentReloading Сообщает прослушивателям, что документ будет перезагружен.
Защищенный метод OnDocumentSaved Сообщает прослушивателям, что документ сохранен.
Защищенный метод OnDocumentSaving Сообщает прослушивателям, что документ будет сохранен.
Защищенный метод OnFileNameChanged Сообщает прослушивателям, что имя файла документа изменилось.
Защищенный метод OnHierarchyChanged Сообщает прослушивателям, что идентификатор элемента, присвоенный документу, был изменен.
Открытый метод 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 Происходит при изменении иерархии или идентификатора элемента документа.

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

Явные реализации интерфейса

  Имя Описание
Явная реализация интерфейсаЗакрытый метод IVsFileBackup.BackupFile Делает одну резервную копию файлов данного документа.
Явная реализация интерфейсаЗакрытый метод IDisposable.Dispose Освобождает все ресурсы, используемые текущим экземпляром класса DocData.
Явная реализация интерфейсаЗакрытый метод IPersistFileFormat.GetClassID Получает идентификатор класса фабрики редактора, создавшей объект.
Явная реализация интерфейсаЗакрытый метод IVsFileBackup.IsBackupFileObsolete Получите информацию, актуальна ли версия файла резервной копии.

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

Заметки

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

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

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

См. также

Ссылки

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