TextPane2 Interface

Represents a pane within a text editor window.

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

public interface TextPane2 : TextPane

The TextPane2 type exposes the following members.

Public propertyCollectionGets the collection containing the TextPane object supporting this property.
Public propertyDTEGets the top-level extensibility object.
Public propertyHeightGets the height of the text pane in character units.
Public propertyIncrementalSearchProvides access to the incremental search (ISearch) capability of the text editor.
Public propertySelectionGets an object representing the current selection on the TextPane object.
Public propertyStartPointGets the TextPoint object representing the first displayed character of the pane.
Public propertyWidthGets the width of the pane in character units.
Public propertyWindowGets the Window object that contains the pane.

Public methodActivateMoves the focus to the current item.
Public methodIsVisibleReturns a value indicating whether the character or specified characters are visible in the text pane.
Public methodTryToShowAdjusts the location of the view in the text buffer so that the indicated range of text is shown in the text pane, if possible. You can control where the text displays in the pane.

You can split a text editor window into two panes. The TextPane object gives you access to the text selected in each pane, as well as the pane's properties such as height, width, and so on.

This example opens a text document and displays some of the text pane properties 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.

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;
public void TextPane2Example(DTE2 dte)
    TextWindow objTW;
    TextPane2 objPane;
    TextPoint objStart;
    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
    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;
    MessageBox.Show("The active pane is " + objPane.Height + " 
lines high and " + objPane.Width + " columns wide.");
    objStart = objPane.StartPoint;
    MessageBox.Show("It begins at line " + objStart.Line 
+ ", column " +  objStart.LineCharOffset + ".");

Community Additions