DTE2.ActiveDocument Property

Article
09/25/2012

Gets the active document.

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

Syntax

'Declaration
ReadOnly Property ActiveDocument As Document

'Usage
Dim instance As DTE2 
Dim value As Document 

value = instance.ActiveDocument

Document ActiveDocument { get; }

property Document^ ActiveDocument {
    Document^ get ();
}

function get ActiveDocument () : Document

Property Value

Type: EnvDTE.Document
A Document object.

Implements

_DTE.ActiveDocument

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."

Examples

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via