TextSelection.StartOfLine(vsStartOfLineOptions, Boolean) Method

Definition

Moves the object to the beginning of the current line.

[System.Runtime.InteropServices.DispId(27)]
public void StartOfLine (EnvDTE.vsStartOfLineOptions Where = EnvDTE.vsStartOfLineOptions.vsStartOfLineOptionsFirstColumn, bool Extend = false);
Parameters
Where
vsStartOfLineOptions

Optional. A vsStartOfLineOptions constant representing where the line starts.

Extend
Boolean

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

Examples

Sub StartOfLineExample()  
   ' 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 to the start of the document. Otherwise, the text selection is collapsed and moved.

Applies to