TextPane Interface

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Represents a pane within a text editor window.

public interface class TextPane

public interface class TextPane

__interface TextPane

[System.Runtime.InteropServices.Guid("0A3BF283-05F8-4669-9BCB-A84B6423349A")]
public interface TextPane

[<System.Runtime.InteropServices.Guid("0A3BF283-05F8-4669-9BCB-A84B6423349A")>]
type TextPane = interface

Public Interface TextPane

Derived

EnvDTE80.TextPane2

Attributes

GuidAttribute

Examples

Sub TextPaneExample(ByVal dte As EnvDTE.DTE)  
    Dim objTW As TextWindow  
    Dim objPane As TextPane  
    Dim objStart As TextPoint  

    objTW = dte.ActiveWindow.Object  
    objPane = objTW.ActivePane  
    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  

public void TextPaneExample(_DTE dte)  
{  
    TextWindow tw;  
    TextPane tpn;  
    TextPoint tpt;  

    tw = (TextWindow)dte.ActiveWindow.Object;  
    tpn = tw.ActivePane;  
    MessageBox.Show ("The active pane is " + tpn.Height.ToString () + "   
    lines high and " + tpn.Width.ToString () + " columns wide.");  
    tpt = tpn.StartPoint;  
    MessageBox.Show ("It begins at line " + tpt.Line.ToString () + ",   
    column " + tpt.LineCharOffset.ToString () + ".");  
}  

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.
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)