Document - интерфейс

Статья
08/11/2011

Представляет в среде документ, открытый для изменения.

Пространство имен: EnvDTE
Сборка: EnvDTE (в EnvDTE.dll)

Синтаксис

'Декларация
<GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")> _
Public Interface Document

[GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
public interface Document

[GuidAttribute(L"63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
public interface class Document

[<GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")>]
type Document =  interface end

public interface Document

Тип Document предоставляет следующие члены.

Свойства

	Имя	Описание
	ActiveWindow	Возвращает активное в настоящий момент окно, или окно, лежащее поверх других, если другие окна неактивны.Возвращает значение Nothing, если открытых окон нет.
	Collection	Получает коллекцию, содержащую объект Document.
	DTE	Возвращает объект расширения верхнего уровня.
	Extender	Возвращает запрашиваемый расширитель, если он доступен для данного объекта.
	ExtenderCATID	Возвращает для объекта ИДЕНТИФИКАТОР категории расширителя (CATID).
	ExtenderNames	Возвращает перечень доступных расширителей объекта.
	FullName	Возвращает полный путь и имя файла объекта.
	IndentSize	Инфраструктура. Только для внутреннего использования В корпорации Майкрософт.
	Kind	Возвращает строку GUID, определяющую вид или тип объекта.
	Language	Инфраструктура. Только для внутреннего использования Майкрософт.
	Name	Получает имя объекта Document.
	Path	Возвращает путь (без имени файла) для каталога, в котором содержится документ.
	ProjectItem	Возвращает мелкое изображение ProjectItem, связанное с объектом Document.
	ReadOnly	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	Saved	Возвращает значение true, если объект не был изменен со времени последнего сохранения или открытия.
	Selection	Возвращает объект, представляющий текущее выделение в объекте Document.
	TabSize	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	Type	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	Windows	Возвращает коллекцию Windows, содержащую окна, отображающиеся в этом объекте.

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

Методы

	Имя	Описание
	Activate	Перемещает фокус на текущий элемент.
	ClearBookmarks	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	Close	Закрывает открытый документ и сохраняет его, либо закрывает и удаляет окно.
	MarkText	Инфраструктура. Только для внутреннего использования в корпорации Майкрософт.
	NewWindow	Создает новое окно просмотра документа.
	Object	Возвращает интерфейс или объект, к которому во время выполнения можно получить доступ по имени.
	PrintOut	Инфраструктура. Только для внутреннего использования Майкрософт.
	Redo	Повторно выполняет последнее действие, которое было отменено методом Undo или пользователем.
	ReplaceText	Инфраструктура. Только для внутреннего использования Майкрософт.
	Save	Сохраняет документ.
	Undo	Отменяет результаты действия, которое было выполнено пользователем в документе последним.

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

Заметки

Объект Document представляет каждый открытый документ или конструктор в среде, то есть в окнах, которые не являются окнами инструментов и имеют область для изменения текста. Объект Document имеет члены (свойства, методы и события), которые можно использовать для управления документом. Если это текстовый файл, правленый в редакторе Visual Studio, он также имеет связанный с ним объект TextDocument.

Ссылки на все открытые документы в коллекции Documents. Просматривая эту коллекцию, можно найти нужный документ.

Свойство по умолчанию для объекта Document — это свойство Name.

Для ссылки на этот объект используется DTE.Documents.Item(...).

Примеры

Sub DocumentExample()
    Dim doc As Document
    Dim desc As String

    Set doc = DTE.ActiveDocument
    desc = "You are editing a "
    If (doc.ReadOnly) Then
        desc = desc & "read-only"
    Else
        desc = desc & "writable"
    End If
    desc = desc & " document called " & doc.Name & " located at " & doc.Path
    MsgBox desc
End Sub

См. также

Ссылки

EnvDTE - пространство имен

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