TextSelection.WordRight(Boolean, Int32) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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 text selection right the specified number of words.

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

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

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

Public Sub WordRight (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 words to move right. The default value is 1.

Attributes: DispIdAttribute

Examples

Sub WordRightExample()  
    ' Before running this example, open a text document.  
    Dim objSel As TextSelection = DTE.ActiveDocument.Selection  
    If objSel.IsEmpty Then  
        ' If there is no text selected, swap the words before and after   
        ' the insertion point. We begin by selecting the word before   
        ' the insertion point.  
        objSel.WordLeft(True)  
        If Not objSel.IsEmpty Then  
            ' We can continue only if the selection was not already at   
            ' the beginning of the document.  
            Dim strBefore As String = objSel.Text  

            ' The text is saved in strBefore; now delete it and move   
            ' past the following word.  
            objSel.Delete()  
            objSel.WordRight(True)  
            If objSel.Text.StartsWith(" ") Or objSel.Text.StartsWith(Microsoft.VisualBasic.ControlChars.Tab) Then  
                ' The previous call to WordRight may have skipped some   
                ' white space instead of an actual word. In that case,   
                ' we should call it again.  
                objSel.WordRight(True)  
            End If  

            ' Insert the new text at the end of the selection.  
            objSel.Insert(strBefore, vsInsertFlags.vsInsertFlagsInsertAtEnd)  
        End If  
    Else  
        ' If some text is selected, replace the following word with the   
        ' text selection.  
        Dim strSelected As String = objSel.Text  

        objSel.MoveToPoint(objSel.BottomPoint)  
        objSel.WordRight(True)  
        If objSel.Text.StartsWith(" ") Or objSel.Text.StartsWith(Microsoft.VisualBasic.ControlChars.Tab) Then  
            ' The previous call to WordRight may have skipped some   
            ' white space instead of an actual word. In that case, we   
            ' should call it again.  
            objSel.WordRight(True)  
        End If  

        ' Insert the text, overwriting the existing text and leaving   
        ' the selection containing the inserted text.  
        objSel.Insert(strSelected, vsInsertFlags.vsInsertFlagsContainNewText)  
    End If  
End Sub

Remarks

If Extend is true, then the active end of the text selection is moved right Count number of words. Otherwise, the text selection is collapsed and positioned Count words right from the active end. If the end of the document is encountered before Count words, then the position remains at the end of the document.

If the value of Count is negative, then WordRight performs like the WordLeft method.

The active language manager for the text document defines the meaning of a "word."

Applies to

Freigeben über