Document 接口

表示在环境中打开进行编辑的文档。

命名空间:  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 获取对象的扩展程序类别 ID (CATID)。
公共属性 ExtenderNames 获取对象的可用扩展程序的列表。
公共属性 FullName 获取对象文件的完整路径和名称。
公共属性 IndentSize 基础结构。仅由 Microsoft 内部使用。
公共属性 Kind 获取一个指示对象种类或类型的 GUID 字符串。
公共属性 Language 基础结构。仅由 Microsoft 内部使用。
公共属性 Name 获取 Document 的名称。
公共属性 Path 获取包含该文档的目录的路径(不带文件名)。
公共属性 ProjectItem 获取与 Document 对象关联的 ProjectItem 对象。
公共属性 ReadOnly 基础结构。仅由 Microsoft 内部使用。
公共属性 Saved 如果对象自上次保存或打开后没有经过修改,则返回 true。
公共属性 Selection 获取表示 Document 上当前选定内容的对象。
公共属性 TabSize 基础结构。仅由 Microsoft 内部使用。
公共属性 Type 基础结构。仅由 Microsoft 内部使用。
公共属性 Windows 获取 Windows 集合,其中包含在对象中显示的窗口。

页首

方法

  名称 说明
公共方法 Activate 将焦点移至当前项。
公共方法 ClearBookmarks 基础结构。仅由 Microsoft 内部使用。
公共方法 Close 关闭打开的文档并可选择保存,或关闭并销毁此窗口。
公共方法 MarkText 基础结构。仅由 Microsoft 内部使用。
公共方法 NewWindow 创建用于查看文档的新窗口。
公共方法 Object 返回一个在运行时可以通过名称访问的接口或对象。
公共方法 PrintOut 基础结构。仅由 Microsoft 内部使用。
公共方法 Redo 重新执行被 Undo 方法或用户撤消的上一操作。
公共方法 ReplaceText 基础结构。仅由 Microsoft 内部使用。
公共方法 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 命名空间