Export (0) Print
Expand All

Documents Interface

Contains all Document objects in the environment, each representing an open document.

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

[GuidAttribute("9E2CF3EA-140F-413E-BD4B-7D46740CD2F4")]
public interface Documents : IEnumerable

The Documents type exposes the following members.

  NameDescription
Public propertyCountGets a value indicating the number of objects in the Documents collection.
Public propertyDTEGets the top-level extensibility object.
Public propertyParentGets the immediate parent object of a Documents collection.
Top

  NameDescription
Public methodAddInfrastructure. Microsoft Internal Use Only.
Public methodCloseAllCloses all open documents in the environment and optionally saves them.
Public methodGetEnumeratorReturns an enumerator for items in the collection.
Public methodItemReturns an indexed member of a Documents collection.
Public methodOpenInfrastructure. Microsoft Internal Use Only.
Public methodSaveAllSaves all documents currently open in the environment.
Top

Reference this collection by using DTE.Documents.

Sub DocumentsExample()
   ' Closes all saved documents.
   Dim iDoc As Integer
   For iDoc = 1 To DTE.Documents.Count
      If DTE.Documents.Item(iDoc).Saved Then
         DTE.Documents.Item(iDoc).Close()
      End If
   Next iDoc
End Sub
Show:
© 2014 Microsoft