TextPane2.Collection Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the collection containing the TextPane object supporting this property.

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

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

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

Public ReadOnly Property Collection As TextPanes

Property Value

TextPanes

A TextPanes collection.

Implements

Collection

Attributes

DispIdAttribute

Examples

Imports EnvDTE  
Imports EnvDTE80  
Sub TextPane2CollectionExample(ByVal dte As DTE2)  
    Dim objTW As TextWindow  
    Dim objPane As TextPane2  
    Dim objTextDoc As TextDocument  
    Dim objTextPt As TextPoint  
    Dim objEP As EditPoint  
    ' Create a new text document.  
    _applicationObject.ItemOperations.NewFile("General\Text File")  
    ' Get a handle to the new document and create EditPoint,  
    ' TextPoint, and TextPane objects.  
    objTextDoc = CType(_applicationObject.ActiveDocument.Object _  
     ("TextDocument"), TextDocument)  
    objEP = objTextDoc.StartPoint.CreateEditPoint  
    objTextPt = objTextDoc.StartPoint  
    ' Plug in some text.  
    objEP.Insert("A test sentence.")  
    objTW = CType(dte.ActiveWindow.Object, TextWindow)  
    objPane = CType(objTW.ActivePane, TextPane2)  
    For Each textPane As TextPane2 In objPane.Collection  
        MsgBox("The caption of the TextPane2 window in the  _  
        TextPane2 collection is:" & vbCr & textPane.Window.Caption)  
    Next  
End Sub  

using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
public void TextPane2CollectionExample(DTE2 dte)  
{  
    TextWindow objTW;  
    TextPane2 objPane;  
    TextDocument objTextDoc;  
    TextPoint objTextPt;  
    EditPoint2 objEP;  
    // Create a new text document.  
    _applicationObject.ItemOperations.NewFile  
(@"General\Text File", "test.txt", Constants.vsViewKindTextView);  
    // Get a handle to the text document and create EditPoint2,  
    // TextPoint, and TextPane2 objects.  
    objTextDoc =(TextDocument)_applicationObject.ActiveDocument.Object  
("TextDocument");  
    objEP = (EditPoint2)objTextDoc.StartPoint.CreateEditPoint();  
    objTextPt = objTextDoc.StartPoint;  
    // Plug in some text.  
    objEP.Insert("A test sentence.");  
    objTW = (TextWindow)_applicationObject.ActiveWindow.Object;  
    objPane = (TextPane2)objTW.ActivePane;  
     foreach (TextPane2 textPane in objPane.Collection)  
    {  
        MessageBox.Show("The caption of the TextPane2 window in   
the TextPane2 collection is:" + "\n" + textPane.Window.Caption);  
    }  
}