EditPoint.WordLeft(Int32) Method

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

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

void WordLeft(int Count = 1);

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

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

Public Sub WordLeft (Optional Count As Integer = 1)

Parameters

Count

Int32

Optional. Specifies how many words to move the edit point to the left of its current position in the buffer.

Attributes

DispIdAttribute

Examples

Sub WordLeftExample()  
   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")  
   objEditPt.WordLeft(3)  
End Sub  

Remarks

WordLeft moves the edit point to the left the indicated number of words. If the beginning of the document is reached before Count words, the point remains at the beginning of the document.

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