TextSelection.CharRight Method

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

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

Syntax

'Declaration
Sub CharRight ( _
    Extend As Boolean, _
    Count As Integer _
)
void CharRight(
    bool Extend,
    int Count
)
void CharRight(
    [InAttribute] bool Extend, 
    [InAttribute] int Count
)
abstract CharRight : 
        Extend:bool * 
        Count:int -> unit 
function CharRight(
    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 right. The default is 1.

Remarks

If Extend is true, then the active end of the selected text is moved right Count characters. Otherwise, the selected text is collapsed and positioned Count characters to the right of the active end.

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

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

Examples

Sub CharRightExample()
   ' 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