0 out of 1 rated this helpful - Rate this topic

DTE2.ActiveDocument Property

Visual Studio 2005

Other Versions

Gets the active document.

Namespace: EnvDTE80
Assembly: EnvDTE80 (in envdte80.dll)

Syntax

C++

Copy

Document ActiveDocument { get; }

Copy

/** @property */
Document get_ActiveDocument ()

JScript

Copy

function get ActiveDocument () : Document

Property Value

A Document object.

Remarks

An active document is one that has focus. To make another document active, set the focus on its window.

You can set the caption only on Tool windows. If you attempt to set the caption on other window types, such as Document windows, you get the error, "Unspecified error."

Example

Copy

Sub ActiveDocumentExample()
  Dim objTextDoc As TextDocument
  Dim objEP As EditPoint
  
  ' Create a new text document.
  Call DTE2.ItemOperations.NewFile("General\Text File")
  'Get a handle to the new document.
  Set objTextDoc = DTE2.ActiveDocument.Object("TextDocument")
  Set objEP = objTextDoc.StartPoint.CreateEditPoint
  'Create an EditPoint and add some text.
  objEP.Insert "A test sentence."
End Sub

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

  Set doc = DTE2.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

Reference

DTE2 Interface
DTE2 Members
EnvDTE80 Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)