TextPane Interface

Represents a pane within a text editor window.

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

Syntax

'Declaration
<GuidAttribute("0A3BF283-05F8-4669-9BCB-A84B6423349A")> _
Public Interface TextPane

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

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

[<GuidAttribute("0A3BF283-05F8-4669-9BCB-A84B6423349A")>]
type TextPane =  interface end

public interface TextPane

The TextPane type exposes the following members.

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	Activate	Moves the focus to the current item.
	IsVisible	Returns a value indicating whether the character or specified characters are visible in the text pane.
	TryToShow	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.

Top

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.

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 () + ".");
}

See Also

Reference

EnvDTE Namespace