EditPoint2.GetLines(Int32, Int32) Method

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a string representing the text between two given lines.

public:
 System::String ^ GetLines(int Start, int ExclusiveEnd);

public:
 Platform::String ^ GetLines(int Start, int ExclusiveEnd);

std::wstring GetLines(int Start, int ExclusiveEnd);

[System.Runtime.InteropServices.DispId(173)]
public string GetLines (int Start, int ExclusiveEnd);

[<System.Runtime.InteropServices.DispId(173)>]
abstract member GetLines : int * int -> string

Public Function GetLines (Start As Integer, ExclusiveEnd As Integer) As String

Parameters

Start: Int32

Optional. The last line number to include the text.

ExclusiveEnd: Int32

Required. The first line number to include the text.

Returns

String

The text between two given lines.

Implements

GetLines(Int32, Int32)

Attributes: DispIdAttribute

Examples

Sub GetLinesExample()  
   Dim objTextDoc As TextDocument  
   Dim objEditPt As EditPoint, iCtr As Integer  

   ' Create a new text file.  
   DTE.ItemOperations.NewFile("General\Text File")  

   ' Get a handle to the new document and create an EditPoint.  
   objTextDoc = DTE.ActiveDocument.Object("TextDocument")  
   objEditPt = objTextDoc.StartPoint.CreateEditPoint  

   ' Insert ten lines of text.  
   For iCtr = 1 To 10  
      objeditpt.Insert("This is a test." & Chr(13))  
   Next iCtr  
   objEditPt.StartOfDocument()  
   msgbox("The results of GetLines: " & Chr(13) & objeditpt.GetLines(1, 6))  
End Sub

Remarks

The returned string represents the text between Start (inclusive) and ExclusiveEnd (exclusive). The string includes newline characters (ACSII character 13) for line boundaries, and ends with a newline character if the last line ended in a newline character.

Applies to

Share via