TextSelection.StartOfLine Method

Moves the object to the beginning of the current line.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Sub StartOfLine ( _
    Where As vsStartOfLineOptions, _
    Extend As Boolean _
)
'Usage
Dim instance As TextSelection 
Dim Where As vsStartOfLineOptions 
Dim Extend As Boolean

instance.StartOfLine(Where, Extend)
void StartOfLine(
    vsStartOfLineOptions Where,
    bool Extend
)
void StartOfLine(
    [InAttribute] vsStartOfLineOptions Where, 
    [InAttribute] bool Extend
)
function StartOfLine(
    Where : vsStartOfLineOptions, 
    Extend : boolean
)

Parameters

  • Extend
    Type: System.Boolean

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

Remarks

If Extend is True, then only the active end of the selected text is moved to the start of the document. Otherwise, the selected text is collapsed and moved.

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

.NET Framework Security

See Also

Reference

TextSelection Interface

TextSelection Members

EnvDTE Namespace