Window2.Collection Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the collection containing the Window object supporting this property.

public:
 property EnvDTE::Windows ^ Collection { EnvDTE::Windows ^ get(); };

[System.Runtime.InteropServices.DispId(2)]
public EnvDTE.Windows Collection { [System.Runtime.InteropServices.DispId(2)] get; }

[<System.Runtime.InteropServices.DispId(2)>]
[<get: System.Runtime.InteropServices.DispId(2)>]
member this.Collection : EnvDTE.Windows

Public ReadOnly Property Collection As Windows

Property Value

Windows

A Windows collection.

Implements

Collection

Attributes

DispIdAttribute

Examples

This example iterates through the collection of windows and displays the window captions.

Imports EnvDTE  
Imports EnvDTE80  
Sub CollectionExample(ByVal dte As DTE2)  
    Try  
      ' Before running this example, create a text file named  
      ' "TextFile1.txt", include it in your solution,  
      ' and make it the active window.  
      Dim win As Window2  
      Dim doc As Document  
      If (_applicationObject.Documents.Count > 0) Then  
        doc = _applicationObject.Documents.Item("TextFIle1.txt")  
        win = CType(doc.ActiveWindow, Window2)  
        ' Show the name of the project that contains this   
        ' window and document.  
        MsgBox("The name of the containing project: " & vbCr _  
        & win.Project.Name)  
        ' Activate the window.  
        win.Activate()  
        ' Show the name of the current ProjectItem in the window.  
        MsgBox("The current project item is: " & win.ProjectItem.Name)  
        ' How many other windows are available?  
        Dim w As String = "Windows: " & vbCr  
        For Each wi As Window In win.Collection  
          w = w & wi.Caption & vbCr  
        Next  
        MsgBox(w)  
        ' Determine that the document returned by the document  
        ' property is the same as the document object 'doc'.  
        If (win.Document Is doc) Then  
          MsgBox("The documents match!")  
        Else  
          MsgBox("The documents do not match!")  
        End If  
        ' Close the window.  
        win.Close(vsSaveChanges.vsSaveChangesYes)  
      End If  
    Catch ex As Exception  
      MsgBox(ex.Message)  
    End Try  
End Sub  

using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
public void CollectionExample(DTE2 dte)  
{  
    try  
    {  
      // Before running, create a text file named   
      // "TextFile1.txt", include it in your solution,  
      // and make it the active window.  
      Window2 win;  
      Document doc;  
      if (dte.Documents.Count > 0)  
      {  
        doc = dte.Documents.Item("TextFile1.txt");  
        win = (EnvDTE80.Window2)doc.ActiveWindow;  
        // Show the name of the project that contains this   
        // window and document.  
        MessageBox.Show(win.Project.Name);  
        win.Activate(); // Activate the window  
        // Show the name of the current ProjectItem in the window.  
        MessageBox.Show(win.ProjectItem.Name);  
        // How many other windows are available?  
        string w = "Windows:\n";  
        foreach (Window wi in win.Collection)  
        {  
          w = w + wi.Caption + "\n";  
        }  
        MessageBox.Show(w);  
        // Determine that the document returned by the document   
        // property is the same as the document object 'doc'.  
        if (win.Document.Equals(doc))  
          MessageBox.Show("The documents match!");  
        else   
           MessageBox.Show("The documents do not match!");  
        // Close the window.  
        win.Close(vsSaveChanges.vsSaveChangesNo);  
      }  
      }  
    catch(Exception ex)  
    {  
      MessageBox.Show(ex.Message);  
    }  
}