TextSelection.CharLeft(Boolean, Int32) 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 the specified number of characters to the left.

void CharLeft(bool Extend = false, int Count = 1);

[System.Runtime.InteropServices.DispId(16)]
public void CharLeft (bool Extend = false, int Count = 1);

[<System.Runtime.InteropServices.DispId(16)>]
abstract member CharLeft : bool * int -> unit

Public Sub CharLeft (Optional Extend As Boolean = false, Optional Count As Integer = 1)

Parameters

Extend: Boolean

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

Count: Int32

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

Attributes: DispIdAttribute

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

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.

Applies to