TextPane Interface

 

Represents a pane within a text editor window.

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

[GuidAttribute("0A3BF283-05F8-4669-9BCB-A84B6423349A")]
public interface TextPane

NameDescription
System_CAPS_pubpropertyCollection

Gets the collection containing the TextPane object supporting this property.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyHeight

Gets the height of the text pane in character units.

System_CAPS_pubpropertySelection

Gets an object representing the current selection on the TextPane object.

System_CAPS_pubpropertyStartPoint

Gets the TextPoint object representing the first displayed character of the pane.

System_CAPS_pubpropertyWidth

Gets the width of the pane in character units.

System_CAPS_pubpropertyWindow

Gets the Window object that contains the pane.

NameDescription
System_CAPS_pubmethodActivate()

Moves the focus to the current item.

System_CAPS_pubmethodIsVisible(TextPoint, Object)

Returns a value indicating whether the character or specified characters are visible in the text pane.

System_CAPS_pubmethodTryToShow(TextPoint, vsPaneShowHow, Object)

Adjusts 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 in the pane the text displays.

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.

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 () + ".");
}
Return to top
Show: