TextPane2.Collection Property
Gets the collection containing the TextPane object supporting this property.
Namespace: EnvDTE80
Assembly: EnvDTE80 (in EnvDTE80.dll)
Syntax
'Declaration
ReadOnly Property Collection As TextPanes
TextPanes Collection { get; }
property TextPanes^ Collection {
TextPanes^ get ();
}
abstract Collection : TextPanes with get
function get Collection () : TextPanes
Property Value
Type: EnvDTE.TextPanes
A TextPanes collection.
Examples
This example opens a text document and uses the Collection property of the text pane to display the active window caption in a message box. For more information about how to run this example as an add-in, see How to: Compile and Run the Automation Object Model Code Examples.
Imports EnvDTE
Imports EnvDTE80
Public Sub OnConnection(ByVal application As Object, _
ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
ByRef custom As Array) Implements IDTExtensibility2.OnConnection
_applicationObject = CType(application, DTE2)
_addInInstance = CType(addInInst, AddIn)
TextPane2CollectionExample(_applicationObject)
End Sub
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 OnConnection(object application,
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
_applicationObject = (DTE2)application;
_addInInstance = (AddIn)addInInst;
TextPane2CollectionExample(_applicationObject);
}
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);
}
}
.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.