EditPoint2.WordRight(Int32) Method

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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 words to the right.

void WordRight(int Count = 1);

[System.Runtime.InteropServices.DispId(108)]
public void WordRight (int Count = 1);

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

Public Sub WordRight (Optional Count As Integer = 1)

Parameters

Count: Int32

Optional. How many words to move the edit point to the right of its current position in the buffer.

Implements

WordRight(Int32)

Attributes: DispIdAttribute

Examples

Sub WordRightExample()  
   Dim objTextDoc As TextDocument  
   Dim objEditPt As EditPoint, iCtr As Integer  

   ' Create a new text file.  
   DTE.ItemOperations.NewFile("General\Text File")  

   ' Get a handle to the new document and create an EditPoint.  
   objTextDoc = DTE.ActiveDocument.Object("TextDocument")  
   objEditPt = objTextDoc.StartPoint.CreateEditPoint  

   ' Insert ten lines of text.  
   For iCtr = 1 To 10  
     objeditpt.Insert("This is a test." & Chr(13))  
   Next iCtr  

   ' Replace the eighth word on the third line with a new word.  
   objEditPt.StartOfDocument()  
   objEditPt.LineDown(3)  
   objEditPt.WordRight(3)  
   objEditPt.Delete(4)  
   objEditPt.Insert("raid")  
End Sub

Remarks

If the end of the document is reached before Count words, the point remains at the end of the document.

If the argument is negative, then WordRight performs similarly to WordLeft.

Applies to

Share via