TextSelection.EndOfLine(Boolean) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Moves the object to the end of the current line.

void EndOfLine(bool Extend = false);

[System.Runtime.InteropServices.DispId(26)]
public void EndOfLine (bool Extend = false);

[<System.Runtime.InteropServices.DispId(26)>]
abstract member EndOfLine : bool -> unit

Public Sub EndOfLine (Optional Extend As Boolean = false)

Parameters

Extend: Boolean

Optional. Determines whether the moved text is collapsed or not. The default is false.

Attributes: DispIdAttribute

Examples

Sub EndOfLineExample()  
   ' Before running this example, open a text document.  
   Dim objSel As TextSelection = DTE.ActiveDocument.Selection  
   Dim objActive As VirtualPoint = objSel.ActivePoint  
   ' Collapse the selection to the beginning of the line.  
   objSel.StartOfLine()  
   ' objActive is "live", tied to the position of the actual selection,   
   ' so it will reflect the new position.  
   Dim iCol As Long = objActive.DisplayColumn  
   ' Move the selection to the end of the line.  
   objSel.EndOfLine()  

   MsgBox("The length of the insertion point line is " & (objActive.DisplayColumn - iCol) & " display characters.")  
End Sub

Remarks

If Extend is true, then only the active end of the text selection is moved. Otherwise, the selection is collapsed and positioned at the end of the document.

Applies to