TextSelection.StartOfLine(vsStartOfLineOptions, Boolean) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.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.

Moves the object to the beginning of the current line.

void StartOfLine(EnvDTE::vsStartOfLineOptions Where = EnvDTE.vsStartOfLineOptions.vsStartOfLineOptionsFirstColumn, bool Extend = false);

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

[<System.Runtime.InteropServices.DispId(27)>]
abstract member StartOfLine : EnvDTE.vsStartOfLineOptions * bool -> unit

Public Sub StartOfLine (Optional Where As vsStartOfLineOptions = EnvDTE.vsStartOfLineOptions.vsStartOfLineOptionsFirstColumn, Optional Extend As Boolean = 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.

Attributes: DispIdAttribute

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

Share via