Share via


TextSelection.CharLeft Method

Moves the object the specified number of characters to the left.

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

Syntax

'Declaration
Sub CharLeft ( _
    Extend As Boolean, _
    Count As Integer _
)
void CharLeft(
    bool Extend,
    int Count
)
void CharLeft(
    [InAttribute] bool Extend, 
    [InAttribute] int Count
)
abstract CharLeft : 
        Extend:bool * 
        Count:int -> unit
function CharLeft(
    Extend : boolean, 
    Count : int
)

Parameters

  • Extend
    Type: System.Boolean

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

  • Count
    Type: System.Int32

    Optional. Represents the number of characters to move to the left. The default is 1.

Remarks

If Extend is True, then the active end of the text selection is moved left Count characters. Otherwise, the text selection is collapsed and positioned Count characters to the left of the active end.

If the beginning of the document is encountered before Count characters, then the position is left at the beginning of the document. If the active end is at the beginning of a line, then CharLeft leaves it at the end of the previous line. That is, all newline sequences are treated as a single character.

If Count is negative, then CharLeft acts like the CharRight.

Examples

Sub ChangeLeftExample()
   ' Open a document before running this example.
   Dim objSel As TextSelection = DTE.ActiveDocument.Selection
   objSel.StartOfDocument(True)
   objSel.StartOfLine(vsStartOfLineOptions.vsStartOfLineOptionsFirstText)
   objSel.CharRight(True, 4)
   objSel.ChangeCase(vsCaseOptions.vsCaseOptionsUppercase)
   MsgBox("Turned text uppercase.")
   objSel.CharLeft(False, 1)
   objSel.ChangeCase(vsCaseOptions.vsCaseOptionsLowercase)
   MsgBox("Turned text lowercase.")
End Sub

.NET Framework Security

See Also

Reference

TextSelection Interface

EnvDTE Namespace