TextPane2 Interface

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Represents a pane within a text editor window.

public interface class TextPane2 : EnvDTE::TextPane

public interface class TextPane2 : EnvDTE::TextPane

__interface TextPane2 : EnvDTE::TextPane

[System.Runtime.InteropServices.Guid("ACE19C7B-A0AC-4089-94FD-749CF4380E1F")]
public interface TextPane2 : EnvDTE.TextPane

[<System.Runtime.InteropServices.Guid("ACE19C7B-A0AC-4089-94FD-749CF4380E1F")>]
type TextPane2 = interface
    interface TextPane

Public Interface TextPane2
Implements TextPane

Attributes

GuidAttribute

Implements

TextPane

Examples

Imports EnvDTE  
Imports EnvDTE80  
Sub TextPane2Example(ByVal dte As DTE2)  
    Dim objTW As TextWindow  
    Dim objPane As TextPane2  
    Dim objStart As TextPoint  
    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 TextPane2 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)  
    MsgBox("The active pane is " & Str(objPane.Height)  _  
    & " lines high and " & Str(objPane.Width) & " columns wide.")  
    objStart = objPane.StartPoint  
    MsgBox("It begins at line " & Str(objStart.Line) & ", column " & _  
     Str(objStart.LineCharOffset) & ".")  
End Sub  

using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
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  
("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;  
    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 + ".");  
}  

Remarks

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.

Properties

Collection	Gets the collection containing the TextPane object supporting this property.
DTE	Gets the top-level extensibility object.
Height	Gets the height of the text pane in character units.
IncrementalSearch	Provides access to the incremental search (ISearch) capability of the text editor.
Selection	Gets an object representing the current selection on the TextPane object.
StartPoint	Gets the TextPoint object representing the first displayed character of the pane.
Width	Gets the width of the pane in character units.
Window	Gets the Window object that contains the pane.

Methods

Activate()	Moves the focus to the current item.
IsVisible(TextPoint, Object)	Returns a value indicating whether the character or specified characters are visible in the text pane.
TryToShow(TextPoint, vsPaneShowHow, Object)