TextPane2.StartPoint Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

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

public:
 property EnvDTE::TextPoint ^ StartPoint { EnvDTE::TextPoint ^ get(); };

public:
 property EnvDTE::TextPoint ^ StartPoint { EnvDTE::TextPoint ^ get(); };

[System.Runtime.InteropServices.DispId(9)]
public EnvDTE.TextPoint StartPoint { [System.Runtime.InteropServices.DispId(9)] get; }

[<System.Runtime.InteropServices.DispId(9)>]
[<get: System.Runtime.InteropServices.DispId(9)>]
member this.StartPoint : EnvDTE.TextPoint

Public ReadOnly Property StartPoint As TextPoint

Property Value

TextPoint

A TextPoint object.

Implements

StartPoint

Attributes

DispIdAttribute

Examples

This example opens a text document and uses the StartPoint property of the text pane to display information about the text start point and end point of the text in the pane in a message box.

Imports EnvDTE  
Imports EnvDTE80  
Sub TextPane2HeightExample(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 TextPane 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 TextPane2HeightExample(DTE2 dte)  
{  
    TextWindow objTW;  
    TextPane2 objPane;  
    TextDocument objTextDoc;  
    TextPoint objTextPt;  
    EditPoint2 objEP;  
    TextPoint objStart;  
    // 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.ToString()   
+ " lines high and " + objPane.Width.ToString() + " columns wide.");  
    objStart = objPane.StartPoint;  
    MessageBox.Show("It begins at line " + objStart.Line.ToString()   
+ ", column " + objStart.LineCharOffset.ToString() + ".");  
}